SDK Node.js da Unimatrix

Instalação

A maneira recomendada de instalar o SDK da Unimatrix para Node.js é usar o gerenciador de pacotes npm, disponível em npm.

Execute o seguinte comando para adicionar uni-sdk como uma dependência ao seu projeto:

npm i uni-sdk

ou use Yarn:

yarn add uni-sdk

Uso

O exemplo a seguir mostra como usar o SDK Node.js da Unimatrix para interagir com os serviços da Unimatrix.

Inicializar um cliente

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

const client = new UniClient({
  accessKeyId: 'seu id de chave de acesso',
  accessKeySecret: 'seu segredo de chave de acesso' // se usar modo de autenticação simples, delete esta linha
})

ou você pode configurar suas credenciais por variáveis de ambiente:

export UNIMTX_ACCESS_KEY_ID=seu_id_de_chave_de_acesso
export UNIMTX_ACCESS_KEY_SECRET=seu_segredo_de_chave_de_acesso

Enviar SMS

Enviar uma mensagem de texto para um único destinatário.

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

client.messages.send({
  to: '+1206880xxxx', // no formato E.164
  text: 'Seu código de verificação é 2048.'
})
  .then(ret => {
    console.log('Resultado:', ret)
  })
  .catch(e => {
    console.error(e)
  })

ou use a palavra-chave async/await:

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

Enviar uma mensagem usando um template com variáveis.

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

Enviar OTP

Enviar um código de passagem único (OTP) para um destinatário. O exemplo a seguir enviará um código de verificação gerado automaticamente para o usuário.

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

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

Verificar OTP

Verificar o código de passagem único (OTP) fornecido pelo usuário. O exemplo a seguir verificará se o código de verificação fornecido pelo usuário está correto.

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

client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' // o código fornecido pelo usuário
})
  .then(ret => {
    console.log('Válido:', ret.valid)
  })