SDK de Unimatrix para Node.js

Instalación

La forma recomendada de instalar el SDK de Unimatrix para Node.js es utilizando el gestor de paquetes npm, disponible en npm.

Ejecuta el siguiente comando para añadir uni-sdk como una dependencia en tu proyecto:

npm i uni-sdk

o usa Yarn:

yarn add uni-sdk

Uso

El siguiente ejemplo muestra cómo usar el SDK de Node.js de Unimatrix para interactuar con los servicios de Unimatrix.

Inicializa un cliente

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

const client = new UniClient({
  accessKeyId: 'tu id de clave de acceso',
  accessKeySecret: 'tu secreto de clave de acceso' // si usas el modo de autenticación simple, elimina esta línea
})

o puedes configurar tus credenciales mediante variables de entorno:

export UNIMTX_ACCESS_KEY_ID=tu_id_de_clave_de_acceso
export UNIMTX_ACCESS_KEY_SECRET=tu_secreto_de_clave_de_acceso

Envía SMS

Envía un mensaje de texto a un único destinatario.

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

client.messages.send({
  to: '+1206880xxxx', // en formato E.164
  text: 'Tu código de verificación es 2048.'
})
  .then(ret => {
    console.log('Resultado:', ret)
  })
  .catch(e => {
    console.error(e)
  })

o usa la palabra clave async/await:

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

Envía un mensaje usando una plantilla con variables.

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

Envía OTP

Envía un código de paso único (OTP) a un destinatario. El siguiente ejemplo enviará un código de verificación generado automáticamente al usuario.

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

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

Verifica OTP

Verifica el código de paso único (OTP) que un usuario proporcionó. El siguiente ejemplo verificará si el código de verificación proporcionado por el usuario es correcto.

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

client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' // el código que proporcionó el usuario
})
  .then(ret => {
    console.log('Válido:', ret.valid)
  })