Référence Générale de l'API

Point de terminaison

https://api.unimtx.com

Visitez Régions et Point de terminaison pour en savoir plus sur les points d'accès mondiaux.

Paramètres Communs

Les paramètres communs sont les paramètres qui doivent être passés lors de l'appel de la requête API et sont uniformément transférés en utilisant les paramètres de requête URL.

Nom	Type	Requis	Description	Exemple
action	string	Oui	Identification de l'interface	sms.message.send
accessKeyId	string	Oui	ID AccessKey de la requête	MvMa9eLy3BBpZqTj49vuAB

Authentification

Unimatrix propose les deux méthodes d'authentification suivantes pour les développeurs à choisir, qui peuvent être configurées dans la Console - Identifiants, le mode Simple étant le mode par défaut.

Mode Simple [Défaut] : Ce mode vérifie uniquement l'ID AccessKey et ne vérifie pas les paramètres de la requête, ce qui facilite l'intégration rapide par les développeurs.
Mode HMAC : Ce mode nécessite l'utilisation du Secret AccessKey pour vérifier les paramètres de la requête afin d'améliorer la sécurité et l'authenticité de la requête.

Mode Simple

Pour utiliser le mode d'authentification simple, il suffit de passer la valeur AccessKey ID de la Console - Identifiants au paramètre de requête URL accessKeyId pour compléter l'authentification.

Mode HMAC

Pour utiliser l'authentification d'accès en mode HMAC, tous les paramètres de requête URL doivent être arrangés dans l'ordre du dictionnaire comme la chaîne de texte à signer et signés selon l'algorithme de hachage de signature spécifié.

Ajoutez les paramètres communs requis à Query comme suit :

Nom	Type	Requis	Description	Exemple
algorithm	string	Oui	Algorithme de hachage de signature, actuellement seul `hmac-sha256` est pris en charge	hmac-sha256
timestamp	number	Oui	Horodatage (ms), tolérance d'acceptation de 10 minutes	1620243278785
nonce	string	Oui	Chaîne aléatoire, accepte une chaîne aléatoire entre 8 et 64 caractères	e1098a414d09d2f6
signature	string	Oui	Chaîne de signature	ZlbgmnCqB7Cgb3WI57Q4zrqq50xiQfi/LPbeL2kC

Générer la signature

Extrayez toutes les paires de paramètres de requête URL dans la requête, triez-les dans l'ordre du dictionnaire (ACS) selon la clé du paramètre, connectez les clés-valeurs avec = et les paires de paramètres avec & pour former la chaîne de texte à signer, par exemple comme suit.
```
accessKeyId=MvMa9eLy3BBpZqTj49vuAB&action=sms.message.send&algorithm=hmac-sha256&nonce=e1098a414d09d2f6&timestamp=1620269782258
```
Utilisant l'algorithme HmacSHA256, le Secret AccessKey correspondant à l'AccessKey ID est utilisé comme clé secrète de signature pour générer une signature pour la chaîne de texte à signer, et la sortie est une chaîne en Base64 (ou Hex), comme dans l'exemple suivant :
```
ZlbgmnCqB7Cgb3WI57Q4zrqq50xiQfi/LPbeL2kC
```

Ajoutez la chaîne de signature comme valeur de signature au paramètre de requête URL de la requête, ce qui résulte dans l'exemple suivant d'une URL de requête complète :

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