LOX24
Overview
LOX24 API Dokumentation (DE) 2.27
Abschnitt betitelt „LOX24 API Dokumentation (DE) 2.27“Einleitung
In diesem Dokument finden Sie die Spezifikation für unsere LOX24 SMS Gateway API. Das Dokument hilft Ihnen dabei unsere SMS API in Ihre Applikation zu integieren und damit SMS zu versenden und zu empfangen. Sie können unsere SMS API unter der URL api.lox24.eu finden. Die einzelnen Funkionen sprechen Sie mit Hilfe eines /funktion an. Z.B. api.lox24.eu/me um Ihre Account Informationen abzurufen oder api.lox24.eu/sms um eine SMS zu versenden.
Highlights
- Nutzen Sie HTTPS, um Ihre Nachrichten SSL verschlüsselt zu übertragen
- Versenden Sie verkettete (überlange) Nachrichten, welche beim Empfänger als eine zusammenhängende SMS ankommen
- Senden Sie Ihre SMS im GSM 03.38 Zeichensatz oder in allen Sprachen als Unicode
- Setzen Sie für jede SMS den Absender als Rufnummer mit bis zu 15 Ziffern oder Text mit bis zu 11 Zeichen
- Senden Sie mit nur einer Anfrage eine Massen-SMS an tausende Rufnummern
- Empfangen Sie SMS einer Inbound-Rufnummer über HTTPS oder per Mail
- Prüfen Sie jederzeit den Status Ihrer SMS
- Sichern Sie die Schnittstelle mit API-Keys und IP-Sperren
Anfragen Content-Type
Der Content-Type für POST und PUT Anfragen wird gesetzt über application/json
oder multipart/form-data (für Schnittstellen mit Dateiupload).
Antwort-Header
Jede API-Antwort enthält eine eindeutige Anforderungskennung im Header „X-LOX24-REQUEST-ID“. Diese 32-stellige alphanumerische Kennung wird für jede Anfrage generiert und kann für Supportzwecke verwendet werden, wenn Probleme gemeldet oder bestimmte API-Aufrufe nachverfolgt werden sollen.
Zeitangaben
Die meisten Zeitangaben werden als unix timestamp (integer) übertragen.
IP-Blockierung
Wenn innerhalb einer Minute mehr als drei Anforderungen mit falschen Authentifizierungsdaten von einer IP-Adresse empfangen werden, dann werden alle nachfolgenden Anfragen von dieser IP für die nächsten zehn Minuten mit einer Antwort Status 429 (Too Many Requests) gesperrt.
Authentication
Alle Funktionen erfordern eine Authentifizierung. Hierzu müssen Sie einen API-Key v2 in Ihrem Web-Account erstellen unter (http://account.lox24.eu “Einstellungen” und “API-Einstellungen”). Sobald Sie den Key erstellt haben übertragen Sie diesen als HTTP header in dieser Form:
curl -X GET https://api.lox24.eu/me \
-H 'Host: api.lox24.eu' \
-H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'curl -X POST https://api.lox24.eu/groups/7116/phones \
-H 'Content-Type: application/json' \
-H 'Host: api.lox24.eu' \
-H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \
-d '{
"phone": "+4917663804817",
"a": "o2"
}'Ältere Authentifizierungsmethode
Wir unterstützen auch weiterhin die alte Version der Authentifizierung mit den beiden Headern ‘X-LOX24-CLIENT-ID’ und ‘X-LOX24-AUTH-TOKEN’, wobei die Client-ID identisch mit der Kundennummer ist, welche für den Login im Web-Account verwendet wird.
curl -X GET https://api.lox24.eu/me \
-H 'Host: api.lox24.eu' \
-H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
-H 'X-LOX24-CLIENT-ID: 1234567'Wichtig!
Teilen oder veröffentkichen Sie Ihren geheimen API-Key niemals. Halten Sie den Key geheim. Ein unabsichtlich veröffentlichter Key kann jederzeit in Ihrem Web-Account (https://account.lox24.eu) in den “Einstellungen” und “API-Einstellungen” deaktiviert oder gelöscht werden.
Authentication
Abschnitt betitelt „ Authentication “In Ihrem Web-Account können Sie nach dem Login unter “Einstellungen” und “API-Einstellungen” einen API-Key erstellen, einsehen, aktivieren oder auch löschen.
Security scheme type: apiKey
Header parameter name: X-LOX24-AUTH-TOKEN