API zur Ergebnisvalidierung | Silent Auth Deutsch

Beschreibung

Der APP-Server ruft diese Schnittstelle auf, um die vom Engagelab SDK zurückgegebenen verschlüsselten Daten (payload) zur Überprüfung der Rufnummernübereinstimmung an den Engagelab-Server zu senden.

Schnittstelleninformationen

Element	Beschreibung
Anforderungspfad	`POST /v1/verify`
Protokoll	HTTPS
Authentifizierung	HTTP Basic Auth
Content-Type	`application/json`

Aktuelle Domain: authapi.engagelab.com

Anforderungsbeispiel

curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \ -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \ -H 'Content-Type: application/json' \ -d '{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }'

              
              curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \
  -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
  }'

Diesen Codeblock im schwebenden Fenster anzeigen

Authentifizierung

Verwenden Sie HTTP Basic Auth zur Authentifizierung:

Authorization: Basic base64(appKey:appSecret)

              
              Authorization: Basic base64(appKey:appSecret)

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel:

appKey: tn4nm0qx032yx6f17q2tsa8f
appSecret: your_app_secret_here
base64-Kodierung: dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

              
              Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

Diesen Codeblock im schwebenden Fenster anzeigen

Anforderungsparameter

Parameter	Typ	Erforderlich	Beschreibung
payload	string	Ja	Die vom Engagelab SDK zurückgegebenen verschlüsselten Daten, von der APP durchgereicht

Beispiel für den Anforderungstext:

{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }

              
              {
  "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwortparameter

Erfolgsantwort (HTTP 200)

Parameter	Typ	Beschreibung
code	int	Statuscode; 0 bedeutet Erfolg
msg	string	Statusbeschreibung
data	object	Antwortdaten
data.message_id	string	Eindeutige Nachrichtenkennung, kann zur Fehlersuche verwendet werden
data.verified	boolean	Ergebnis der Rufnummernprüfung; true bedeutet übereinstimmend, false bedeutet nicht übereinstimmend

Erfolgsbeispiel (Prüfung bestanden):

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": true } }

              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": true
  }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Erfolgsbeispiel (Prüfung nicht bestanden):

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": false } }

              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": false
  }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort (HTTP 4xx/5xx)

Parameter	Typ	Beschreibung
code	int	Fehlercode
msg	string	Fehlerbeschreibung

Fehlerbeispiel:

{ "code": 2001, "msg": "auth failed" }

              
              {
  "code": 2001,
  "msg": "auth failed"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode	HTTP-Statuscode	Beschreibung	Empfohlene Maßnahme
1000	500	Interner Serverfehler	Bitte später erneut versuchen; bei anhaltendem Auftreten den technischen Support kontaktieren
2001	401	Authentifizierung fehlgeschlagen	Prüfen Sie, ob appKey und appSecret korrekt sind und ob das Authorization-Format der Spezifikation entspricht
2004	401	Ungültiger appKey	Prüfen Sie, ob der appKey korrekt ist, oder kontaktieren Sie den technischen Support, um zu bestätigen, ob der Dienst aktiviert ist
3001	400	Ungültiges Parameterformat	Prüfen Sie, ob der Anforderungstext gültiges JSON ist
3002	400	Parametervalidierung fehlgeschlagen	Prüfen Sie, ob der payload-Parameter vorhanden und korrekt formatiert ist
3003	400	appKey stimmt nicht überein	Der appKey im payload stimmt nicht mit dem appKey im Authentifizierungs-Header überein; stellen Sie sicher, dass Sie das richtige Schlüsselpaar verwenden
3004	400	Konfiguration nicht aktiviert	Die Dienstkonfiguration ist noch nicht aktiviert; bitte kontaktieren Sie den technischen Support zur Aktivierung
3005	400	Unzureichendes Guthaben	Das Kontoguthaben ist unzureichend; bitte laden Sie auf und versuchen Sie es erneut
4001	400	Konfiguration nicht gefunden	Die entsprechende Dienstkonfiguration wurde nicht gefunden; bitte kontaktieren Sie den technischen Support
5001	400	Verifizierung fehlgeschlagen	Während des Carrier-Authentifizierungsprozesses ist eine Ausnahme aufgetreten; analysieren Sie anhand der Details in msg oder kontaktieren Sie den technischen Support

Hinweise

Payload-Durchreichung: Nachdem die APP den vom Engagelab SDK zurückgegebenen payload erhalten hat, muss sie ihn unverändert an den APP-Server übermitteln, der dann diese Schnittstelle aufruft. Ändern Sie den payload in keiner Weise.
Sicherheitsempfehlung: Bewahren Sie das appSecret sicher auf und verwenden Sie es nur serverseitig; geben Sie es nicht in der APP preis.
Verifizierungsergebnis: Ein verified-Wert von false bedeutet, dass die vom Nutzer eingegebene Telefonnummer nicht mit der SIM-Karten-Telefonnummer übereinstimmt und die Nutzeranmeldung abgelehnt werden sollte.