REVpager API

Aus REV Plus Handbuch
Wechseln zu: Navigation, Suche

Aufgrund vieler Nachfragen kann der REVpager nun auch von eigenen Anwendungen heraus ausgelöst werden. Dazu wurde eine REST API implementiert, die das Versenden der Alarme für Entwickler einfach zugänglich macht.

Die REST API kann grundsätzlich nur verschlüsselt über HTTPS angesprochen werden. Jede Anfrage muss den Authentifizierungsheader mit dem für Sie ausgestellten API Key enthalten. Setzen Sie dazu im Anfrageheader den Header "Auth-Token" auf den für Sie ausgestellten Wert (Einsehbar im Kundenportal). Bitte beachten Sie, dass sie dieses Token geheim halten, da sonst von anderen Personen (kostenpflichtige) Alarme ausgelöst werden können.

Die REST API bietet verschiedene Methodenaufrufe zur Verfügung. Meistens sind dies POST Anfragen, die einen JSON Body mit den Daten enthalten. Der Content-Type muss auf "application/json" gesetzt werden. Ein Rückkanal ist derzeit noch nicht implementiert aber geplant.

Nachricht senden

Um eine einfache Nachricht an einen oder mehrere Empfänger senden zu können, senden Sie eine POST Anfrage an /api/v1/message

Der Inhalt der Anfrage muss folgendem Format enstprechen:

{
 "receivers" : [ "receiver1@example.org", "receiver2@example.org" ],
 "message" : "Dies ist eine Testnachricht!"
}