SDK Ruby de Unimatrix
Installation
La méthode recommandée pour installer le SDK Unimatrix pour Ruby est d'utiliser le gestionnaire de paquets gem, disponible sur RubyGems.
Exécutez la commande suivante pour ajouter uni-sdk
comme dépendance à votre projet :
gem install uni-sdk
Si vous installez via Bundler, ajoutez cette ligne au Gemfile
de votre application :
gem 'uni-sdk'
Utilisation
L'exemple suivant montre comment utiliser le SDK Ruby Unimatrix pour interagir avec les services Unimatrix.
Initialiser un client
require 'uni-sdk'
client = Uni::Client.new('votre access key id', 'votre access key secret') # si vous utilisez le mode d'authentification simple, passez juste le premier paramètre
ou vous pouvez configurer vos identifiants via 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.
require 'uni-sdk'
client = Uni::Client.new()
begin
resp = client.messages.send({
to: '+1206880xxxx', # au format E.164
text: 'Votre code de vérification est 2048.'
})
puts resp.data
rescue Uni::UniError => e
puts 'Exception : ' + e.message
end
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 de passe unique (OTP) à un destinataire. L'exemple suivant enverra un code de vérification généré automatiquement à l'utilisateur.
require 'uni-sdk'
client = Uni::Client.new()
resp = client.otp.send({
to: '+1206880xxxx'
})
puts resp.data
Vérifier OTP
Vérifiez le code de passe unique (OTP) fourni par l'utilisateur. L'exemple suivant vérifiera si le code de vérification fourni par l'utilisateur est correct.
require 'uni-sdk'
client = Uni::Client.new()
resp = client.otp.verify({
to: '+1206880xxxx',
code: '123456' # le code fourni par l'utilisateur
})
puts resp.valid