Definition
Eine REST API ist eine Web-Schnittstelle, die Ressourcen wie Nachrichten, Kontakte oder Vorlagen unter URLs bereitstellt und es Programmen ermöglicht, sie mit Standard-HTTP-Methoden (POST, GET, PATCH, DELETE) anzulegen, abzurufen, zu ändern und zu löschen – in der Regel mit JSON als Austauschformat.
REST (Representational State Transfer) ist ein Architekturstil, den Roy Fielding im Jahr 2000 beschrieben hat. In der Praxis bedeutet eine Messaging-REST-API, einen authentifizierten HTTPS-Request zu senden, etwa POST /messages mit JSON-Body, und eine JSON-Antwort mit ID und Status zu erhalten. HTTP-Statuscodes zeigen das Ergebnis an: 2xx für Erfolg, 4xx für Client-Fehler wie ungültige Nummern oder fehlende Autorisierung, 5xx für Serverfehler.
Typische Muster: Bearer-Token-Authentifizierung im Authorization-Header, Idempotency Keys, damit Wiederholungsversuche keine Duplikate erzeugen, Paginierung für Listen, Rate Limits mit Retry-After-Headern und Webhooks für asynchrone Ergebnisse wie Zustellberichte.
REST eignet sich für die meisten Integrationen: CRMs, E-Commerce-Plattformen und Backoffice-Systeme. Für sehr hohe SMS-Volumina nutzen Carrier und Aggregatoren dagegen häufig SMPP, das eine dauerhafte Verbindung offen hält.
Eine OpenAPI-Spezifikation beschreibt die Endpunkte maschinenlesbar, sodass sich Client-SDKs, Dokumentation und Tests daraus generieren lassen.
OmniChannels.ai stellt unter https://api.broadnet.me eine REST/JSON-API mit Bearer-Token-Authentifizierung, einer OpenAPI-3.1-Spezifikation und einem TypeScript-SDK bereit.
Beispiel
POST https://api.broadnet.me/… mit dem Header "Authorization: Bearer <token>" und einem JSON-Body; die Antwort liefert eine Message-ID.