SDK Python da Unimatrix

Instalação

Usar pip é a maneira recomendada de instalar o SDK da Unimatrix para Python, que está disponível no PyPI.

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

pip install uni-sdk

Uso

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

Inicializar um cliente

from uni.client import UniClient

client = UniClient("seu id de chave de acesso", "seu segredo de chave de acesso") # se usando modo de autenticação simples, apenas passe 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

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

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

client = UniClient()

try:
  res = client.messages.send({
    "to": "+1206880xxxx", # no formato E.164
    "text": "Seu código de verificação é 2048."
  })
  print(res.data)
except UniException as e:
  print(e)

Enviar uma mensagem usando um template com variáveis.

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

Enviar OTP

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

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

client = UniClient()

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

Verificar OTP

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

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

client = UniClient()

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