REST API

Erfahren Sie, wie Sie die EngageLab OTP REST API integrieren und verwenden.

Der EngageLab OTP-Dienst stellt eine Reihe von RESTful-APIs bereit, mit denen Sie programmgesteuert Vorlagen erstellen, OTPs senden und Codes verifizieren können.

Folgen Sie diesen Schritten, um mit der REST API zu beginnen.

Einen API Key erstellen

Bevor Sie eine EngageLab OTP API aufrufen, müssen Sie einen API Key generieren, um Ihre Anfragen zu authentifizieren.

Melden Sie sich bei der EngageLab-Konsole an.
Rufen Sie die OTP-Subkonsole auf und wählen Sie Ihre Anwendung aus.
Navigieren Sie in der linken Navigationsleiste zu API Keys.
Klicken Sie auf API Key erstellen, um einen neuen dev_key und ein neues dev_secret zu generieren.

⚠️ Warnung
Ihr dev_secret ist hochsensibel. Bewahren Sie es sicher auf und geben Sie es niemals in clientseitigem Code oder öffentlichen Repositories preis.

Authentifizierung

Die EngageLab OTP API verwendet HTTP Basic Authentication. Sie müssen in allen API-Anfragen den Authorization-Header einbinden.

Dieser Header wird durch Base64-Codierung Ihres dev_key und Ihres dev_secret erstellt:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Diesen Codeblock im schwebenden Fenster anzeigen

${base64_auth_string} wird erzeugt, indem Ihr dev_key und Ihr dev_secret, durch einen Doppelpunkt (:) verbunden, Base64-codiert werden: base64(dev_key:dev_secret).

Weitere Einzelheiten finden Sie in der Anleitung Authentifizierung.

Die API aufrufen

Sobald Sie Ihren API Key haben und den Authentifizierungsmechanismus verstehen, können Sie mit dem Aufrufen der APIs beginnen. Alle API-Endpunkte verwenden die Basis-URL https://otp.api.engagelab.cc.

Hier sind einige der wichtigsten APIs, die Sie integrieren können:

OTP senden: Generieren Sie einen Verifizierungscode über die EngageLab-Plattform und senden Sie ihn gemäß Ihrer Vorlagenstrategie.
OTP verifizieren: Verifizieren Sie das vom Benutzer übermittelte Einmalpasswort (Verifizierungscode) sicher.
Benutzerdefiniertes OTP senden: Wenn Sie den Verifizierungscode lieber selbst generieren möchten, können Sie den vorab generierten Code an den Benutzer senden.
Benutzerdefinierte Nachricht senden: Senden Sie Nachrichteninhalte (z. B. Benachrichtigungen oder Marketingnachrichten) auf Basis einer benutzerdefinierten Vorlage.
Vorlagenverwaltung: Erstellen, löschen, rufen Sie die Liste aller Vorlagen programmgesteuert ab und sehen Sie sich Vorlagendetails an.
Callback-Konfiguration: Konfigurieren Sie Callback-Adressen und verwenden Sie sichere Verifizierungsmechanismen, um Statusberichte und Benachrichtigungen zu empfangen.
Lebenszyklus-Status-Callback: Empfangen Sie über Callbacks Echtzeitdaten zu Lebenszyklusstatus von Nachrichten wie Versand, Zustellung und Verifizierung.
SMPP: Erreichen Sie über TCP-Verbindungen mit dem SMPP-Protokoll eine effiziente und zuverlässige Nachrichtenzustellung und Statusmeldung.