SDK de Unimatrix para Python

Instalación

Usar pip es la forma recomendada de instalar el SDK de Unimatrix para Python, que está disponible en PyPI.

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

pip install uni-sdk

Uso

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

Inicializar un cliente

from uni.client import UniClient

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

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

client = UniClient()

try:
  res = client.messages.send({
    "to": "+1206880xxxx", # en formato E.164
    "text": "Tu código de verificación es 2048."
  })
  print(res.data)
except UniException as e:
  print(e)

Enviar un mensaje usando 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.

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

client = UniClient()

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

Verificar OTP

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

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

client = UniClient()

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