Aucun résultat

Vérification du mot de passe à usage unique (OTP)

API URL

URL utilisée pour envoyer les requêtes HTTP :

https://portal.bulkgate.com/api/1.0/otp/verify
Note

Si la requête n'atteint pas sa destination, renvoyez-la sur le serveur de secours backup1.bulkgate.com.

Méthodes HTTP prises en charge

  • POST - application/json
POST /api/1.0/otp/verify HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Tableau des paramètres

NOM DU PARAMÈTRE VALEUR OBLIGATOIRE VALEUR PAR DÉFAUT
application_id Application ID Oui -
application_token Application token Oui -
id ID reçu lors de l'envoi du mot de passe à usage unique Oui -
code Code à vérifier Oui -

Exemple de requête

POST /api/1.0/otp/verify HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "id": "otp-id", "code": "0000" }

Réponse

En cas de succès :

{ "data": { "id": "otp-id", "verified": true } }

En cas de code non valide :

{ "data": { "id": "otp-id", "verified": false } }

En cas d'erreur :

{ "type": "unknown_identity", "code": 400, "error": "Unknown identity", "detail": null } { "type": "invalid_input_parameters", "code": 400, "error": "Invalid input parameters", "detail": null }

Où :

  • type et error (description de l'erreur) figurent dans le tableau des types d'erreurs
  • code représente le code d'erreur HTTP
  • detail est une information complémentaire sur l'erreur
Cette page vous a-t-elle été utile ?