Referencia General de la API
Endpoint
https://api.unimtx.com
Visite Regiones y Endpoint para ver más sobre los puntos de acceso globales.
Parámetros Comunes
Los parámetros comunes son los parámetros que deben pasarse al llamar a la solicitud de la API y se transfieren uniformemente utilizando parámetros de consulta de URL.
Nombre | Tipo | Requerido | Descripción | Ejemplo |
---|---|---|---|---|
action | string | Sí | Identificación de la interfaz | sms.message.send |
accessKeyId | string | Sí | ID de AccessKey de solicitud | MvMa9eLy3BBpZqTj49vuAB |
Autenticación
Unimatrix ofrece los siguientes dos métodos de autenticación para que los desarrolladores elijan, que se pueden configurar en la Consola - Credenciales, siendo el modo Simple el predeterminado.
- Modo Simple [Predeterminado]: Este modo solo verifica el ID de AccessKey y no verifica los parámetros de la solicitud, facilitando la integración rápida de los desarrolladores.
- Modo HMAC: Este modo requiere el uso de
AccessKey Secret
para verificar los parámetros de la solicitud para mejorar la seguridad y autenticidad de la solicitud.
Modo Simple
Para utilizar la autenticación en modo simple, simplemente pase el valor de AccessKey ID
de la Consola - Credenciales al parámetro de consulta de URL accessKeyId
para completar la autenticación.
Modo HMAC
Para utilizar la autenticación de acceso en modo HMAC, todos los parámetros de consulta de URL deben organizarse en orden alfabético como la cadena de texto a firmar y firmarse según el algoritmo de hash de firma especificado.
Añada los parámetros comunes requeridos a la consulta de la siguiente manera:
Nombre | Tipo | Requerido | Descripción | Ejemplo |
---|---|---|---|---|
algorithm | string | Sí | Algoritmo de hash de firma, actualmente solo se admite hmac-sha256 | hmac-sha256 |
timestamp | number | Sí | Marca de tiempo (ms), tiempo de tolerancia de aceptación 10 minutos | 1620243278785 |
nonce | string | Sí | Cadena aleatoria, acepta una cadena aleatoria entre 8-64 caracteres | e1098a414d09d2f6 |
signature | string | Sí | Cadena de firma | ZlbgmnCqB7Cgb3WI57Q4zrqq50xiQfi/LPbeL2kC |
Generar firma
-
Extraiga todos los pares de parámetros de consulta de URL en la solicitud, ordénelos en orden alfabético (ASC) según la clave del parámetro, conecte los valores clave con
=
y los pares de parámetros con&
para formar la cadena de texto a firmar, por ejemplo, como sigue.accessKeyId=MvMa9eLy3BBpZqTj49vuAB&action=sms.message.send&algorithm=hmac-sha256&nonce=e1098a414d09d2f6×tamp=1620269782258
-
Usando el algoritmo
HmacSHA256
, elAccessKey Secret
correspondiente alAccessKey ID
se usa como la clave secreta de firma para generar una firma para la cadena de texto a firmar, y la salida es una cadena en Base64 (o Hex), como en el siguiente ejemplo:ZlbgmnCqB7Cgb3WI57Q4zrqq50xiQfi/LPbeL2kC
-
Añadiendo la cadena de firma como el valor de
signature
al parámetro de consulta de URL de la solicitud envía la solicitud, resultando en el siguiente ejemplo de URL de solicitud completa:https://api.unimtx.com/?action=sms.message.send&accessKeyId=MvMa9eLy3BBpZqTj49vuAB&algorithm=hmac-sha256×tamp=1620269782258&nonce=e1098a414d09d2f6&signature=xvv9UjzOrQFWe7fFS5IUU9iqIZrncvF093SqXsnfcK8%3D