First OTP Verification - EngageLab OTP Quick Access Guide
1. Vorbereitung
Um EngageLab OTP zum Generieren, Versenden und Verifizieren von Einmalpasswörtern (OTP) zu nutzen, müssen Entwickler:innen vorab folgende Schritte durchführen:
1.1 Vorlagen konfigurieren
Befolgen Sie die Anleitung unter OTP-Vorlage erstellen, um den Vorlagennamen, die Vorlagen-ID, den Markennamen, die OTP-Länge und die Gültigkeitsdauer für EngageLab OTP zu konfigurieren.
1.2 API-Schlüssel erstellen
Um die EngageLab OTP API zum Generieren oder Verifizieren von Einmalpasswörtern zu verwenden, müssen Sie einen API-Basic-Authentifizierungsschlüssel erstellen. Dieser kann gemäß der Anleitung unter OTP API-Schlüssel erstellen angelegt werden.
2. OTPs versenden
Es gibt zwei Möglichkeiten, Ihre erste OTP-Verifizierungsnachricht mit EngageLab zu versenden:
2.1 Versand über die Backend-Website
2.1.1 OTP generieren und versenden
Melden Sie sich auf der EngageLab Backend-Website an und navigieren Sie zum Menüpunkt [API-Test] > [OTP-Versand]. Geben Sie dort den erstellten API-Schlüssel, die Ziel-Telefonnummer oder E-Mail-Adresse, die Vorlagen-ID und die Vorlagensprache ein:
Klicken Sie nach dem Ausfüllen auf „OTP-Anfrage senden“, um ein Einmalpasswort zu generieren und an die angegebene Ziel-Telefonnummer oder E-Mail-Adresse zu senden.
Im Feld „Antwort“ unten werden bei erfolgreicher Anfrage der Antwortkanal und die message_id angezeigt:
Bei einer fehlgeschlagenen Anfrage werden im Feld „Antwort“ unten der spezifische Fehlercode und die Fehlermeldung angezeigt:
Nach erfolgreichem Versand können Sie unter Nachrichtendetails in den Verlaufseinträgen das generierte Einmalpasswort und die message_id einsehen.
2.1.2 OTP verifizieren
Melden Sie sich auf der EngageLab Backend-Website an und navigieren Sie zum Menüpunkt [API-Test] > [OTP-Verifizierung]. Geben Sie den erstellten API-Schlüssel, die message_id sowie das generierte Einmalpasswort ein. Klicken Sie nach dem Ausfüllen auf die Schaltfläche „OTP-Verifizierungsanfrage“:
2.2 API-Integration
Für die Integration der EngageLab OTP API in Ihren Code beachten Sie bitte die folgenden Dokumente:
3. Verlaufseinträge einsehen
Nach erfolgreichem Versand können Sie auf der Seite [Verlaufseinträge] den Namen der Vorlage, den Versandzeitpunkt, das Ziel, den Nachrichtenstatus und die geschätzten Kosten einsehen. Weitere Informationen finden Sie im Dokument: EngageLab OTP Verlaufseinträge
