Verwendung der HTML-API und SSE
In dieser Einrichtungshilfe wird beschrieben, wie Sie die HTML-API und SSE der BEHNKE-STATION einrichten und verwenden.
Die Behnke-Station stellt mit der
HTML-API und Server-Sent Events (SSE) zwei Schnittstellen für den Zugriff über das Netzwerk zur Verfügung. Über die HTML-API können Einstellungen der Behnke-Station abgefragt und geändert sowie bestimmte Ereignisse ausgelöst werden. Die Kommunikation erfolgt über HTTP- beziehungsweise HTTPS-Anfragen.
Server-Sent Events (SSE) ermöglichen dagegen eine dauerhafte Verbindung zwischen einem Client und der Behnke-Station. Über diese Verbindung kann die Station auftretende Ereignisse, beispielsweise erkannte Tastendrücke, unmittelbar an den verbundenen Client übertragen.
Beide Schnittstellen sind standardmäßig deaktiviert und müssen vor der Verwendung explizit freigegeben werden. Für den Zugriff ist das Administrator-Passwort erforderlich.
Wichtig
Es wird angenommen, dass die Behnke-Station bereits soweit eingerichtet ist, dass ein Zugriff auf die Weboberfläche möglich ist. Sollte dies nicht der Fall sein, folgen Sie der Anleitung ihrer Basiselektronik (BedienungsanleitungenDiese Seite trägt keine Versionsangabe. Dieser Hinweis wird automatisch erzeugt und stammt nicht von der Redaktion.) und dem technischen HandbuchDiese Seite trägt keine Versionsangabe. Dieser Hinweis wird automatisch erzeugt und stammt nicht von der Redaktion. um die grundlegende Einrichtung abzuschließen.
Tipp
Alle eingebauten Tools in diesem Wiki-Artikel funktionieren AUSCHLIEßLICH mit HTTPS. Bevor Sie diese Tools verwenden können müssen Sie die Weboberfläche des Gerätes mit diesem Endgerät besuchen und die Zertifikatswarnung akzeptieren.
1. HTML-API und SSE aktivieren
- Öffnen Sie ihren Browser
- Rufen Sie die Weboberfläche der Behnke-Station auf
- Melden Sie sich an
- Klicken Sie links in der Seitenleiste auf den Menüpunkt
- Navigieren Sie zum Abschnitt API
- Setzen Sie den Wert der Option Zugriff auf HTML-API auf den Wert erlauben
- Setzen Sie den Wert der Option Zugriff auf SSE auf den Wert erlauben
- Klicken Sie auf um die Konfiguration zu speichern
2. HTML-API verwenden
Die HTML-API ermöglicht es, Funktionen der Behnke-Station über HTTP- beziehungsweise HTTPS-Anfragen aufzurufen. Je nach verwendetem API-Befehl können Informationen abgefragt, Einstellungen geändert oder Aktionen ausgelöst werden.
Hinweis
Die Verwendung der HTML-API muss zuvor in der Konfiguration der Behnke-Station erlaubt werden. Siehe 1.
Das allgemeine Schema eines API-Aufrufs lautet:
https://[IP-Adresse]/?key=[Administrator-Passwort]&api=[Befehl]
Dabei werden folgende Angaben benötigt:
- [IP-Adresse]: IP-Adresse der Behnke-Station
- [Administrator-Passwort]: Administrator-Passwort der Behnke-Station
- [Befehl]: auszuführender API-Befehl
- gegebenenfalls weitere Parameter des jeweiligen Befehls
Wichtig
Enthält das Administrator-Passwort Sonderzeichen, müssen diese für die Verwendung innerhalb der URL entsprechend URL-kodiert werden.
2.1 API-Befehl erstellen
Zum Erstellen eines gültigen API-Aufrufs kann der integrierte API Command Builder verwendet werden.
Die Station wird ausschließlich über HTTPS angesprochen. Ihr Zertifikat kennt der Browser nicht — öffnen Sie die Station deshalb einmal über Schritt 1 und bestätigen Sie die Warnung. Passwort und IP bleiben in Ihrem Browser; beim Öffnen im neuen Tab steht das Passwort allerdings in der Adresszeile.API-Befehl zusammenstellen
Gerät
Rohdaten der Abfragen
Der API Command Builder unterstützt Sie beim Zusammenstellen des Befehls und der benötigten Parameter.
2.2 API-Aufruf testen
Zum Testen eines API-Aufrufs kann der integrierte API Tester verwendet werden.
Die Station wird ausschließlich über HTTPS angesprochen. Ihr Zertifikat kennt der Browser nicht — öffnen Sie die Station deshalb einmal über Schritt 1 und bestätigen Sie die Warnung. Passwort und IP bleiben in Ihrem Browser; beim Öffnen im neuen Tab steht das Passwort allerdings in der Adresszeile. Alles, was in der Doku hinter &api= steht — zum Beispiel get§ions oder trigger&relay=1.API-Test
Alternativ kann ein API-Aufruf direkt über einen Webbrowser oder einen anderen HTTP-Client ausgeführt werden.
Beispiel für den Aufruf der API-Hilfe:
https://[IP-Adresse]/?key=[Administrator-Passwort]&api=help
Über den Befehl help können weitere Informationen zu den verfügbaren API-Befehlen abgerufen werden.
Tipp
Verwenden Sie nach Möglichkeit immer HTTPS, damit das Administrator-Passwort und weitere übertragene Daten verschlüsselt übertragen werden.
3. Server-Sent Events (SSE) verwenden
Mit Server-Sent Events kann eine dauerhafte Verbindung zwischen einem Client und der Behnke-Station hergestellt werden.
Nach dem Aufbau der Verbindung bleibt diese geöffnet. Die Behnke-Station kann darüber auftretende Ereignisse unmittelbar an den verbundenen Client übertragen. Dazu können beispielsweise erkannte Tastendrücke oder andere Ereignisse der Station gehören.
Hinweis
Die Verwendung von SSE muss zuvor in der Konfiguration der Behnke-Station erlaubt werden.
Für den Aufbau der Verbindung wird das Administrator-Passwort benötigt.
Die Verbindung kann über HTTP oder HTTPS aufgebaut werden:
http://[IP-Adresse]:8080/?key=[Administrator-Passwort]&sse
beziehungsweise:
https://[IP-Adresse]:8443/?key=[Administrator-Passwort]&sse
Wichtig
Enthält das Administrator-Passwort Sonderzeichen, müssen diese für die Verwendung innerhalb der URL entsprechend URL-kodiert werden.
3.1 SSE-Verbindung testen
Zum Testen der SSE-Schnittstelle kann der integrierte SSE Tester verwendet werden.
Die Station wird ausschließlich über HTTPS angesprochen. Ihr Zertifikat kennt der Browser nicht — öffnen Sie die Station deshalb einmal über Schritt 1 und bestätigen Sie die Warnung. Passwort und IP bleiben in Ihrem Browser; beim Öffnen im neuen Tab steht das Passwort allerdings in der Adresszeile.SSE-Test
Nach erfolgreichem Verbindungsaufbau werden von der Behnke-Station übertragene Ereignisse im Tester angezeigt.
Tipp
Verwenden Sie nach Möglichkeit die verschlüsselte Verbindung über HTTPS auf Port 8443.
4. HTTP und HTTPS
Für die HTML-API und SSE sollte grundsätzlich HTTPS verwendet werden. Dadurch werden das Administrator-Passwort sowie weitere übertragene Informationen verschlüsselt übertragen.
HTTP-Verbindungen sind nur möglich, wenn diese über die Einstellung Webverbindungen im Bereich Allgemein ausdrücklich erlaubt wurden.
| Schnittstelle | HTTP | HTTPS |
|---|---|---|
| HTML-API | http://[IP-Adresse]/?... |
https://[IP-Adresse]/?... |
| SSE | http://[IP-Adresse]:8080/?... |
https://[IP-Adresse]:8443/?... |
5. Besonderheit bei Verwendung eines Webcam-VLANs
Für die HTML-API wird grundsätzlich die IP-Adresse der Behnke-Station verwendet.
Bei SSE gilt eine Besonderheit: Ist im Bereich Netzwerk ein separates VLAN für die Webcam konfiguriert, muss für die SSE-Verbindung die IP-Adresse der Webcam verwendet werden.
FAQ
Hinweis
Zur Zeit sind hier noch keine Inhalte verfügbar. Sobald Inhalte geplant sind, werden die Seiten mit geplant angezeigt. Nutzen Sie gerne die Funktion Problem melden rechts in der Toolbar, um neue Inhalte zu anzufordern, Fragen zu stellen oder Unklarheiten zu melden.
Außerdem können Sie hinter jeder Überschrift Feedback geben, damit wir unser Wiki kontinuierlich verbessern können:
- Bewegen Sie ihre Maus auf die Überschrift
- Es erscheint ein kleines ?
- Klicken Sie auf das kleine ?
Wir freuen uns über jede Anregung, jede Korrektur und jeden Verbesserungsvorschlag.