Nic nenalezeno

Ověření One Time Password (OTP)

API URL

Adresa URL používaná k odeslání požadavků HTTP:

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

Nedostane-li se požadavek k cíli, zopakujte ho na záložním serveru backup1.bulkgate.com.

Podporované HTTP metody

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

Tabulka s parametry

JMÉNO PARAMETRU HODNOTA POVINNÝ VÝCHOZÍ HODNOTA
application_id Application ID Ano -
application_token Application token Ano -
id ID získané po odeslání SEND nebo RESEND požadavku Ano -
code Verifikační kód ke kontrole Ano -

Příklad požadavku

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

Odpověď

V případě úspěchu:

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

V případě neplatného kódu:

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

V případě 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) najdete v tabulce typů chyb
  • code je HTTP kód chyby
  • detail je doplňující informace o chybě
Byla tato stránka užitečná?