Nič sa nenašlo

Overenie One Time Password (OTP)

API URL

Adresa URL používaná na odosielanie HTTP požiadaviek:

https://portal.bulkgate.com/api/1.0/otp/verify
Poznámka

Ak sa požiadavka nedostane k cieľu, zopakujte ju na záložnom serveri backup1.bulkgate.com.

Podporované HTTP metódy

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

Tabuľka s parametrami

NÁZOV PARAMETRA HODNOTA POVINNÝ PREDVOLENÁ HODNOTA
application_id Application ID Áno -
application_token Application token Áno -
id ID získané po odoslaní požiadavky SEND alebo RESEND Áno -
code Overovací kód na kontrolu Áno -

Príklad požiadavky

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" }

Odpoveď

V prípade úspechu:

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

V prípade neplatného kódu:

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

V prípade chyby:

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

Kde:

  • type a error (popis chyby) nájdete v tabuľke typov chýb
  • code je HTTP kód chyby
  • detail je doplňujúca informácia o chybe
Bola táto stránka užitočná?