SDK de Unimatrix para Ruby

Instalación

La forma recomendada de instalar el SDK de Unimatrix para Ruby es utilizar el gestor de paquetes gem, que está disponible en RubyGems.

Ejecuta el siguiente comando para agregar uni-sdk como una dependencia a tu proyecto:

gem install uni-sdk

Si estás instalando a través de Bundler, añade esta línea a tu Gemfile de la aplicación:

gem 'uni-sdk'

Uso

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

Inicializar un cliente

require 'uni-sdk'

client = Uni::Client.new('tu id de clave de acceso', 'tu secreto de clave de acceso') # si usas el modo de autenticación simple, solo pasa el primer parámetro

o puedes configurar tus credenciales por 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

Enviar SMS

Enviar un mensaje de texto a un único destinatario.

require 'uni-sdk'

client = Uni::Client.new()

begin
  resp = client.messages.send({
    to: '+1206880xxxx', # en formato E.164
    text: 'Tu código de verificación es 2048.'
  })
  puts resp.data
rescue Uni::UniError => e
  puts 'Excepción: ' + e.message
end

Enviar un mensaje utilizando una plantilla con variables.

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

Enviar OTP

Enviar 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.

require 'uni-sdk'

client = Uni::Client.new()

resp = client.otp.send({
  to: '+1206880xxxx'
})
puts resp.data

Verificar OTP

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

require 'uni-sdk'

client = Uni::Client.new()

resp = client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' # el código proporcionado por el usuario
})
puts resp.valid