🌐 Was ist die RESTful API?
Die REST-API ermöglicht es, direkt auf Funktionen des Gateways zuzugreifen – etwa zum Abrufen von Nachrichten, Statusinformationen oder Logs.
Gut zu wissen: Die API lässt sich direkt in der Weboberfläche interaktiv testen – ganz ohne externe Tools!
🚀 Schnellstart: Interaktive API nutzen
📍 Navigiere in der Weboberfläche zu:
Konfiguration → RESTful API → Interaktive API
Dort findest du eine Auswahl an API-Endpunkten, die direkt getestet werden können – inklusive Eingabefeldern für Parameter.
🔍 Beispiel: Nachrichten über GET /messages
abfragen
Mit dem Endpunkt GET /messages
kannst du alle versendeten und empfangenen SMS innerhalb eines bestimmten Zeitraums abrufen.
🗓️ Datumsformat – Achtung: UNIX-Timestamps erforderlich!
Die Zeitangaben für Start und Ende erfolgen nicht im Klartext (z. B. 2024-04-26), sondern im sogenannten UNIX-Zeitformat (Anzahl Sekunden seit 01.01.1970).
🧭 Beispiel:
Datum | UNIX-Timestamp |
---|---|
01.01.2024 00:00:00 | 1704067200 |
31.12.2024 23:59:59 | 1735689599 |
➡️ Hilfreiches Tool zur Umrechnung:
www.unixtimestamp.com
✅ Beispielhafte API-Anfrage
🔎 Damit werden alle Nachrichten zwischen dem 01.01.2024 und dem 31.12.2024 geladen.
🛠️ Zusätzliche Hinweise zur Nutzung
-
Zeitzone beachten:
Timestamps basieren auf UTC – bei Bedarf in lokale Zeit umrechnen! -
Parameter optional:
Wenn dustart
undend
weglässt, wird der komplette Nachrichtenverlauf geladen (sofern nicht durch Server-Limits eingeschränkt) -
URL-Encoding:
Sonderzeichen wie+
,:
oder Leerzeichen müssen ggf. URL-kodiert werden.
→ Beispiel:+
wird zu%2B
📌 Zusammenfassung der Parameter
Parameter | Beschreibung | Format |
---|---|---|
start |
Startzeitpunkt der Abfrage | UNIX-Timestamp |
end |
Endzeitpunkt der Abfrage | UNIX-Timestamp |
💡 Tipps für Entwickler und Power-User
Für automatisierte Abfragen oder Tests außerhalb der Weboberfläche kannst du folgende Tools verwenden:
-
Postman – grafisches Tool für API-Abfragen
-
curl
– Kommandozeilen-Tool (Linux, macOS, Windows) -
Eigene REST-Clients in Python, Go, Node.js etc.
🔄 Kombiniert mit einem Timestamp-Konverter lassen sich zeitgesteuerte Reports oder Monitoring-Lösungen realisieren.
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.