Benachrichtigungen Per Http Request An Fremdsysteme; Konfiguration Des Http Requests - Speck-Pumpen BADU Blue Bedienungsanleitung

28 BENACHRICHTIGUNGEN PER HTTP REQUEST AN FREMDSYSTEME

28.1 KONFIGURATION DES HTTP REQUESTS

█ MENÜ ► KONFIGURATION ► BENACHRICHTIGUNGEN
Die BADU Blue kann alle Benachrichtigungen, die per Email oder PUSH Nachricht gesendet werden können, auch
als HTTP-Request (GET oder POST) an Fremdsysteme absetzen (z.B. Deine Hausautomation). Über diese Requests
können Warnungen und Alarme in dem eigenen System verarbeitet werden. Die Empfänger Schnittstelle auf
dem Systemen muss entsprechend selbst bereitgestellt werden, dazu kann keinen Support angeboten werden.
Die BADU Blue sendet in den HTTP Requests den Fehlercode der entsprechenden Warnung / des entsprechenden
Alarms und eine Kurzbeschreibung des Fehlers. Die möglichen Fehlercodes und die Kurzbeschreibung dazu
können der angehängten Liste in Punkt 28.2. dieser Anleitung entnommen werden.
Die beiden Parameter für Fehlercode und Kurzbeschreibung werden dabei im POST oder GET Request der BADU
Blue wie folgt versendet:
Fieldname
ERRORCODE =
SUBJECT =
Einstellbare Parameter:
[http Requests]
[URL/IP zur Empfänger-API (ohne
http://)]
[Pfad zur Empfänger-API (inkl ‚/')]
[Basis-Query]
[Methode]
[API-Response-body (success)]
Value
<vierstelliger Fehlercode>
<Kurzbeschreibung des Fehlers>
Aktiviert oder deaktiviert den Versand von HTTP Requests global.
Die IP-Adresse oder URL zu dem System. Die Angabe hat ohne http:// zu
erfolgen und es ist nur die IP-Adresse oder der Domainname einzugeben.
Der verwendete Port beim Empfänger muss Port 80 sein.
Der Pfad zur Empfänger-API (Script/Programm) das den Request
verarbeiten soll. Der Pfadangabe ist ein „/" voranzustellen und es muss
der vollständige Pfad zu der API angegeben werden.
Falls an die API ein bestimmtes field/value pair gesendet werden
muss/soll, welches in jedem Request enthalten ist, kann das in dem
Parameter [Basis Query] mit angegeben werden. Das Eingabeformat ist
wie folgt: fieldname=value
Wenn z.B. zur Identifikation noch ein Feld mit dem Namen „sender" und
dem Wert „BADU Blue" in jedem Request versendet werden soll, lautet
die Eingabe wie folgt: sender=BADU Blue
Es können auch mehrere field/value pairs mit einem „&" in folgender
Form aneinanderreihen: sender=BADU Blue&user=JohnDoe&BADU
Blue=cute
Die Paare werden dann von der BADU Blue zusammen mit ERRORCODE
und SUBJECT versendet
Legt fest ob der Request als GET oder als POST versendet wird.
Der Empfänger API muss eine Antwort im response-body zurücksenden,
anhand derer die BADU Blue erkennt, ob der Request erfolgreich war
oder nicht.
[129]