SDK Node.js de Unimatrix

Installation

La méthode recommandée pour installer le SDK Unimatrix pour Node.js est d'utiliser le gestionnaire de paquets npm, disponible sur npm.

Exécutez la commande suivante pour ajouter uni-sdk comme dépendance à votre projet :

npm i uni-sdk

ou utilisez Yarn :

yarn add uni-sdk

Utilisation

L'exemple suivant montre comment utiliser le SDK Node.js Unimatrix pour interagir avec les services Unimatrix.

Initialiser un client

const { UniClient } = require('uni-sdk')

const client = new UniClient({
  accessKeyId: 'votre access key id',
  accessKeySecret: 'votre access key secret' // si vous utilisez le mode d'authentification simple, supprimez cette ligne
})

ou vous pouvez configurer vos identifiants par des variables d'environnement :

export UNIMTX_ACCESS_KEY_ID=votre_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=votre_access_key_secret

Envoyer SMS

Envoyez un message texte à un seul destinataire.

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.messages.send({
  to: '+1206880xxxx', // au format E.164
  text: 'Votre code de vérification est 2048.'
})
  .then(ret => {
    console.log('Résultat :', ret)
  })
  .catch(e => {
    console.error(e)
  })

ou utilisez le mot-clé async/await :

try {
  const ret = await client.messages.send({
    // ...
  })
  console.log('Résultat :', ret)
} catch (e) {
  console.error(e)
}

Envoyez un message en utilisant un modèle avec des variables.

client.messages.send({
  to: '+1650253xxxx',
  signature: 'Unimatrix',
  templateId: 'pub_otp_fr',
  templateData: {
    code: '2048'
  }
})

Envoyer OTP

Envoyez un code à usage unique (OTP) à un destinataire. L'exemple suivant enverra un code de vérification généré automatiquement à l'utilisateur.

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.otp.send({
  to: '+1206880xxxx'
})
  .then(ret => {
    console.log('Résultat :', ret)
  })

Vérifier OTP

Vérifiez le code à usage unique (OTP) fourni par un utilisateur. L'exemple suivant vérifiera si le code de vérification fourni par l'utilisateur est correct.

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' // le code fourni par l'utilisateur
})
  .then(ret => {
    console.log('Valide :', ret.valid)
  })