Validation OTP
Point de terminaison
POST https://otp.api.engagelab.cc/v1/verifications
Authentification
Utilisez l’authentification HTTP Basic et incluez Authorization dans l’en-tête HTTP :
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Afficher ce bloc de code dans la fenêtre flottante
Le base64_auth_string est généré comme suit : base64(dev_key:dev_secret).
Exemple de requête
En-têtes de requête
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Afficher ce bloc de code dans la fenêtre flottante
Corps de la requête
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de la requête
| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | ID du message correspondant au code de vérification, renvoyé par l’API /messages |
| verify_code | String | Required | Code de vérification à valider |
Paramètres de réponse
Réponse réussie
| Field | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | ID du message correspondant au code de vérification, renvoyé par l’API /v1/messages |
| verify_code | String | Required | Code de vérification à valider |
| verified | Boolean | Required | Résultat de la validation. true indique que la validation a réussi et false qu’elle a échoué |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Afficher ce bloc de code dans la fenêtre flottante
Remarque : si une demande de validation est effectuée pour le code de vérification d’un même message et que le code est validé avec succès, toute requête ultérieure vers cette API de validation échouera et renverra un message indiquant que le code de vérification de ce message a déjà été validé. En d’autres termes, les codes de vérification déjà validés avec succès ne peuvent pas être validés à nouveau.
Réponse en échec
Le code de statut HTTP est 4xx ou 5xx, et le corps de la réponse contient les champs suivants :
| Field | Type | Required | Description |
|---|---|---|---|
| code | int | Required | Code d’erreur. Pour plus de détails, voir Codes d’erreur |
| message | String | Required | Détails de l’erreur |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
Afficher ce bloc de code dans la fenêtre flottante
Codes d’erreur
| Error Code | HTTP Code | Description |
|---|---|---|
| 1000 | 500 | Erreur interne |
| 2001 | 401 | Échec de l’authentification : le jeton correct n’a pas été fourni |
| 2002 | 401 | Échec de l’authentification : le jeton a expiré ou a été désactivé |
| 2004 | 403 | Aucune autorisation pour appeler cette API |
| 3001 | 400 | Format de paramètre de requête invalide. Veuillez vérifier si le contenu JSON respecte le format de paramètre requis |
| 3002 | 400 | Paramètres de requête invalides. Veuillez vérifier si les paramètres de requête respectent les exigences |
| 3003 | 400 | Le code de vérification a expiré ou a déjà été vérifié. Pour les réponses avec ce code d’erreur, un nouveau message contenant un code de vérification doit être envoyé |
| 3011 | 400 | Code de vérification expiré |
| 4001 | 400 | Le message n’existe pas |
