REST API

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

Der EngageLab SMS Dienst bietet eine Reihe von RESTful-APIs, mit denen Sie programmgesteuert Vorlagen und Signaturen erstellen, SMS senden und Ihr Guthaben abfragen können.

Bitte folgen Sie den nachstehenden Schritten, um mit der Nutzung der REST API zu beginnen.

Einen API Key erstellen

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

1. Melden Sie sich bei der EngageLab Konsole an.
2. Rufen Sie die SMS-Unterkonsole auf und wählen Sie Ihre Anwendung aus.
3. Navigieren Sie zu API Keys in der linken Navigationsleiste.
4. Klicken Sie auf API Key erstellen, um einen neuen dev_key und dev_secret zu generieren.

⚠️ Warnung
Ihr dev_secret ist hochsensibel. Bitte bewahren Sie ihn sicher auf und geben Sie ihn niemals in clientseitigem Code oder öffentlichen Code-Repositorys preis.

Authentifizierung

Die EngageLab SMS API verwendet HTTP-Basic-Authentifizierung. Sie müssen einen Authorization-Header in alle API-Anfragen aufnehmen.

Der Header wird durch Base64-Kodierung Ihres dev_key und dev_secret erstellt:

              
              Authorization: Basic ${base64_auth_string}

            

${base64_auth_string} wird generiert, indem Ihr dev_key und dev_secret mit einem Doppelpunkt (:) verbunden und das Ergebnis Base64-kodiert werden: base64(dev_key:dev_secret).

Weitere Einzelheiten finden Sie im Leitfaden zur 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://smsapi.engagelab.com.

Nachfolgend finden Sie mehrere wichtige APIs, die Sie integrieren können:

• SMS senden: Senden Sie SMS an einzelne oder mehrere Zielmobilnummern und unterstützen Sie den automatisierten Versand von Benachrichtigungs- und Marketing-SMS.
• Guthaben abfragen: Fragen Sie das verfügbare Guthaben Ihres EngageLab SMS Kontos in Echtzeit über die API ab, einschließlich Informationen zu allgemeinem Guthaben und Bonusguthaben.
• Vorlagenverwaltung: Erstellen, ändern, löschen Sie Vorlagen programmgesteuert, rufen Sie alle Vorlagenlisten ab und sehen Sie sich Vorlagendetails an.
• Signaturverwaltung: Erstellen, ändern, löschen Sie Signaturen programmgesteuert, rufen Sie alle Signaturlisten ab und sehen Sie sich Signaturdetails an.
• Callback-Ereignisreferenz: Konfigurieren Sie Callback-URLs und verwenden Sie sichere Verifizierungsmechanismen, um Statusberichte und Benachrichtigungen zu empfangen.
• SMPP: Verwenden Sie das SMPP-Protokoll über eine TCP-Verbindung für eine effiziente, zuverlässige Nachrichtenzustellung und Statusberichterstattung.