Docs
Menu

Referência Geral da API

Endpoint

https://api.unimtx.com

Visite Regiões e Ponto de Extremidade para saber mais sobre pontos de acesso globais.

Parâmetros Comuns

Os parâmetros comuns são os parâmetros que devem ser passados ao chamar a solicitação da API e são uniformemente transferidos usando parâmetros de Query URL.

NomeTipoObrigatórioDescriçãoExemplo
actionstringSimIdentificação da interfacesms.message.send
accessKeyIdstringSimID de Acesso da chave de requisiçãoMvMa9eLy3BBpZqTj49vuAB

Autenticação

A Unimatrix fornece os seguintes dois métodos de autenticação para os desenvolvedores escolherem, que podem ser configurados no Console - Credenciais, sendo o modo Simples o padrão.

  • Modo Simples [Padrão]: Este modo verifica apenas o ID da AccessKey e não verifica os parâmetros da solicitação, facilitando a integração rápida dos desenvolvedores.
  • Modo HMAC: Este modo requer o uso do AccessKey Secret para verificar os parâmetros da solicitação para aumentar a segurança e a autenticidade da solicitação.

Modo Simples

Para usar a autenticação em modo simples, basta passar o valor do AccessKey ID obtido no Console - Credenciais para o parâmetro de Query URL accessKeyId para completar a autenticação.

Modo HMAC

Para usar a autenticação de acesso no modo HMAC, todos os parâmetros de Query URL devem ser organizados em ordem alfabética como a string de texto a ser assinada e assinada de acordo com o algoritmo de hash de assinatura especificado.

Adicione os parâmetros comuns necessários à Query conforme segue:

NomeTipoObrigatórioDescriçãoExemplo
algorithmstringSimAlgoritmo de hash de assinatura, atualmente apenas hmac-sha256 é suportadohmac-sha256
timestampnumberSimTimestamp (ms), tempo de tolerância de aceitação 10 minutos1620243278785
noncestringSimString aleatória, aceita uma string aleatória entre 8-64 caracterese1098a414d09d2f6
signaturestringSimString de assinaturaZlbgmnCqB7Cgb3WI57Q4zrqq50xiQfi/LPbeL2kC

Gerar assinatura

  1. Extraia todos os pares de parâmetros de Query URL na solicitação, ordene-os em ordem alfabética (ACS) de acordo com a chave do parâmetro, conecte os Key-Values com = e os pares de parâmetros com & para formar a string de texto a ser assinada, por exemplo como segue.

    accessKeyId=MvMa9eLy3BBpZqTj49vuAB&action=sms.message.send&algorithm=hmac-sha256&nonce=e1098a414d09d2f6&timestamp=1620269782258

  2. Usando o algoritmo HmacSHA256, a AccessKey Secret correspondente ao AccessKey ID é usada como a chave secreta de assinatura para gerar uma assinatura para a string de texto a ser assinada, e a saída é uma string em Base64 (ou Hex), como no seguinte exemplo:

    ZlbgmnCqB7Cgb3WI57Q4zrqq50xiQfi/LPbeL2kC

  3. Adicionando a string de assinatura como o valor de signature ao parâmetro de Query URL da solicitação envia a solicitação, resultando no seguinte exemplo de URL de solicitação completa:

    https://api.unimtx.com/?action=sms.message.send&accessKeyId=MvMa9eLy3BBpZqTj49vuAB&algorithm=hmac-sha256&timestamp=1620269782258&nonce=e1098a414d09d2f6&signature=xvv9UjzOrQFWe7fFS5IUU9iqIZrncvF093SqXsnfcK8%3D
Nesta página