API-Schnittstellen im Messaging

Wie eine Messaging-API funktioniert

Der Austausch läuft in zwei Richtungen. Ausgehend sendet das eigene System einen Aufruf an die Plattform: Empfänger, Kanal, Inhalt und Referenz auf den auslösenden Vorgang.

Eingehend meldet die Plattform Ereignisse zurück — Zustellung, Lesebestätigung, Klick, Antwort oder Abmeldung. Diese Rückmeldungen erreichen das eigene System meist über einen Webhook, also einen Aufruf an eine hinterlegte Adresse.

Was dabei ausgetauscht wird

Übergeben werden Rufnummer, Vorlagenkennung oder Nachrichtentext, Variablen für die Personalisierung sowie eine eigene Referenz, über die sich die Rückmeldung später dem Vorgang zuordnen lässt.

Authentifizierung und Ereignisarten

Der Zugang läuft über einen Schlüssel, der jedem Aufruf beiliegt und einem Konto zugeordnet ist. Zurückgemeldet werden üblicherweise die Zustände angenommen, zugestellt und endgültig gescheitert, dazu Lesebestätigungen, eingehende Antworten und Abmeldungen.

Jedes Ereignis trägt die Kennung der ursprünglichen Nachricht. Darüber verbindet das Quellsystem die Rückmeldung wieder mit dem auslösenden Vorgang — der Bestellung, dem Termin, dem Anmeldeversuch.

API vs. Weboberfläche vs. Datei-Upload

Auslöser: Die API reagiert auf ein Ereignis im eigenen System, die Weboberfläche auf eine manuelle Auswahl, der Datei-Upload manuell oder zeitgesteuert.

Zeitpunkt: Die API versendet unmittelbar zum Vorgang, die Weboberfläche zum Versandzeitpunkt, der Datei-Upload zum Importzeitpunkt.

Personalisierung: Die API greift auf Livedaten zurück, die Weboberfläche auf Listenfelder, der Datei-Upload auf den Dateistand.

Rückfluss: Die API liefert Ereignisse ins eigene System zurück, die Weboberfläche eine Auswertung in der Oberfläche, der Datei-Upload einen Bericht als Datei.

Typischer Einsatz: Die API eignet sich für Transaktions- und Ereignisnachrichten, die Weboberfläche für einzelne Kampagnen, der Datei-Upload für wiederkehrende Massenversände.

Voraussetzungen und Grenzen

Zugangsdaten und Schlüssel werden serverseitig gehalten, nicht im Browser oder in einer App ausgeliefert.

Rufnummern liegen in einheitlichem internationalem Format vor, sonst kann die Zustellung scheitern.

Ratenbegrenzungen und Wiederholungslogik gehören zur Anbindung, weil Ereignisse mehrfach eintreffen können.

Abmeldungen werden über die Schnittstellen in alle für künftige Aussendungen maßgeblichen Systeme übernommen. Eine nur in der Versandplattform gespeicherte Abmeldung verhindert weitere Nachrichten aus anderen Systemen nicht zuverlässig.

Eine Testumgebung ohne echten Versand trennt Entwicklung vom Produktivbetrieb.

Zeitstempel laufen aus mehreren Netzen zusammen und werden einheitlich geführt, sonst lassen sich Ereignisse nicht in eine verlässliche Reihenfolge bringen.

Welche Kanäle sich über eine gemeinsame Schnittstelle ansprechen lassen, zeigt die Kanalübersicht von helleo.