SDK Ruby da Unimatrix

Instalação

A maneira recomendada de instalar o SDK da Unimatrix para Ruby é usar o gerenciador de pacotes gem, disponível em RubyGems.

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

gem install uni-sdk

Se você está instalando via Bundler, adicione esta linha ao Gemfile da sua aplicação:

gem 'uni-sdk'

Uso

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

Inicialize um cliente

require 'uni-sdk'

client = Uni::Client.new('seu id de chave de acesso', 'seu segredo de chave de acesso') # se usando o modo de autenticação simples, passe apenas o primeiro parâmetro

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

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

require 'uni-sdk'

client = Uni::Client.new()

begin
  resp = client.messages.send({
    to: '+1206880xxxx', # no formato E.164
    text: 'Seu código de verificação é 2048.'
  })
  puts resp.data
rescue Uni::UniError => e
  puts 'Exceção: ' + e.message
end

Envie uma mensagem usando um template com variáveis.

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

Enviar OTP

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

require 'uni-sdk'

client = Uni::Client.new()

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

Verificar OTP

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

require 'uni-sdk'

client = Uni::Client.new()

resp = client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' # o código fornecido pelo usuário
})
puts resp.valid