Esendex API

Einleitung

Die neue Esendex API (Application Programming Interface) ist einfach, schlank und wurde auf einfachen und etablierten Standards aufgebaut, die die Notwendigkeit spezieller Toolkits reduzieren. Esendex kann auf diese Weise mehr Programmiersprachen unterstützen, und dies einfacher als je zuvor.

In diesem Begleitdokument wird der „RESTful“-Ansatz beschrieben, der von der API für die Business Messaging Services von Esendex bereitgestellt wird. Diese Dokumentation soll alle Informationen bereitstellen, die benötigt werden, um mit dem Einsatz der API zu beginnen.

Esendex API-Dokumentation

Die Esendex API basiert auf dem REST-Architekturstil und wurde auf Grundlage des HTTP-Protokolls implementiert. Sie verwendet die HTTP-Standardmethoden GET, POST, PUT und DELETE, um mit mehreren definierten Ressourcen zu interagieren. Bei den Anfragen an und den Antworten von der REST API handelt es sich um UTF-8-kodierte XML-Repräsentationen.
Damit Sie die Esendex API einsetzen können, benötigen Sie:

• eine aktive Internet-Verbindung
• Mittel zur Verarbeitung von HTTP-Anfrage/Antwort-Objekten
• XML-Parsing-Funktionalität

HTTP-Methoden

Es gibt vier HTTP-Hauptmethoden oder -Ausdrücke, die zur Interaktion mit der Esendex API verwendet werden. Dabei handelt es sich um GET, POST, PUT und DELETE.

Die Verwendung dieser Ausdrücke beschreibt die an einer Ressource ausgeführten Operationen in der folgenden Weise:

• GET
  • Ruft eine Repräsentation der angeforderten Ressource ab (aktueller Status).
• POST
  • Erstellt eine neue Instanz einer Ressource.
• PUT
  • Aktualisiert eine bestehende Instanz einer Ressource.
• LÖSCHEN
  • Entfernt eine bestehende Instanz einer Ressource.

Schnelleinstieg

Hier werden die beiden grundlegenden Aufgaben „Nachrichten senden“ und „Nachrichten empfangen“ eingeführt, damit Sie schnell die Ressourcen identifizieren können, die zur Durchführung dieser Kernoperationen benötigt werden.

Esendex API verwenden

Jede Interaktion mit der Esendex API folgt denselben grundlegenden Schritten:

1. Sammeln der benötigten Daten, um die Anfrage zu stellen.
2. Erstellen einer HTTP-Anforderung. Vergessen Sie dabei nicht, den Authentication-Header und alle weiteren Datenparameter anzugeben.
3. Aufrufen der HTTP-Anforderung an die entsprechende Ressource-URI unter Verwendung einer unterstützten HTTP-Methode.
4. Abrufen und Parsen der HTTP-Antwort.
5. Verwenden Sie ggf. die Antwortdaten, um die weitere Operationen auszuführen.

Nachrichten senden

Um Nachrichten zu versenden, müssen Sie wissen, wie die Message Dispatcher-Ressource verwendet wird. Jeder Nachricht, die erfolgreich über Esendex versendet wird, wird ein eindeutiger GUID-Wert (Globally Unique Identifier) zugeordnet. Anhand dieser ID können später über die Message Headers-Ressource Nachrichtendetails abgerufen werden, inkl. dem Auslieferstatus.

Nachrichten empfangen

Der Empfang von Nachrichten erfolgt entweder über den Abruf der Nachrichten aus der Inbox-Ressource oder über den Push-Notification-Mechanismus Account Event Handler.

Beispielsweise müssen Sie zum Abrufen der Nachrichten im Postfach einfach eine GET-Anforderung an für http://api.esendex.com/v1.0/inbox/messages ausführen.