OTP-Validierung
Endpoint
POST https://otp.api.engagelab.cc/v1/verifications
Authentifizierung
Verwenden Sie zur Authentifizierung HTTP Basic Authentication und fügen Sie Authorization in den HTTP-Header ein:
Authorization: Basic ${base64_auth_string}
Der base64_auth_string wird wie folgt generiert: base64(dev_key:dev_secret)
Anfragebeispiel
Anfrage-Header
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Anfrage-Body
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Anfrageparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| message_id | String | Erforderlich | Die Nachrichten-ID, die dem Verifizierungscode entspricht und von der /messages-API zurückgegeben wird |
| verify_code | String | Erforderlich | Der zu validierende Verifizierungscode |
Antwortparameter
Erfolgreiche Antwort
| Field | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | Die Nachrichten-ID, die dem Verifizierungscode entspricht und von der /v1/messages-API zurückgegeben wird |
| verify_code | String | Required | Der zu validierende Verifizierungscode |
| verified | Boolean | Required | Das Validierungsergebnis. true zeigt an, dass die Validierung erfolgreich war, und false zeigt an, dass die Validierung fehlgeschlagen ist |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Hinweis: Wenn eine Validierungsanfrage für den Verifizierungscode derselben Nachricht gestellt wird und der Code erfolgreich validiert wurde, schlägt jede nachfolgende Anfrage an diese Validierungs-API fehl und gibt eine Meldung zurück, dass der Verifizierungscode für diese Nachricht bereits validiert wurde. Mit anderen Worten: Verifizierungscodes, die bereits erfolgreich validiert wurden, können nicht erneut validiert werden.
Fehlgeschlagene Antwort
Der HTTP-Statuscode ist 4xx oder 5xx, und der Antwort-Body enthält die folgenden Felder:
| Field | Type | Required | Description |
|---|---|---|---|
| code | int | Required | Fehlercode. Weitere Details finden Sie unter Fehlercodes |
| message | String | Required | Fehlerdetails |
{
"code": 3003,
"message": "verify code has expired"
}
Fehlercodes
| Fehlercode | HTTP-Code | Beschreibung |
|---|---|---|
| 1000 | 500 | Interner Fehler |
| 2001 | 401 | Authentifizierung fehlgeschlagen: Das korrekte Token wurde nicht bereitgestellt |
| 2002 | 401 | Authentifizierung fehlgeschlagen: Das Token ist abgelaufen oder wurde deaktiviert |
| 2004 | 403 | Keine Berechtigung, diese API aufzurufen |
| 3001 | 400 | Ungültiges Format der Anfrageparameter. Bitte prüfen Sie, ob der JSON-Inhalt dem erforderlichen Parameterformat entspricht |
| 3002 | 400 | Ungültige Anfrageparameter. Bitte prüfen Sie, ob die Anfrageparameter die Anforderungen erfüllen |
| 3003 | 400 | Der Verifizierungscode ist abgelaufen oder wurde bereits verifiziert. Bei Antworten mit diesem Fehlercode muss eine neue Verifizierungscode-Nachricht gesendet werden |
| 3011 | 400 | Verifizierungscode abgelaufen |
| 4001 | 400 | Die Nachricht existiert nicht |
