SDK Python de Unimatrix

Installation

Utiliser pip est la méthode recommandée pour installer le SDK Unimatrix pour Python, qui est disponible sur PyPI.

Exécutez la commande suivante pour ajouter uni-sdk comme dépendance à votre projet :

pip install uni-sdk

Utilisation

L'exemple suivant montre comment utiliser le SDK Python Unimatrix pour interagir avec les services Unimatrix.

Initialiser un client

from uni.client import UniClient

client = UniClient("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 par 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.

from uni.client import UniClient
from uni.exception import UniException

client = UniClient()

try:
  res = client.messages.send({
    "to": "+1206880xxxx", # au format E.164
    "text": "Votre code de vérification est 2048."
  })
  print(res.data)
except UniException as e:
  print(e)

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

from uni.client import UniClient
from uni.exception import UniException

client = UniClient()

res = client.otp.send({
  "to": "+1206880xxxx"
})
print(res.data)

Vérifier OTP

Vérifiez le code de passe unique (OTP) fourni par un utilisateur. L'exemple suivant vérifiera si le code de vérification fourni par l'utilisateur est correct.

from uni.client import UniClient
from uni.exception import UniException

client = UniClient()

res = client.otp.verify({
  "to": "+1206880xxxx",
  "code": "123456" # le code fourni par l'utilisateur
})
print(res.valid)