{"wiki":"de","slug":"guide-system-html-sse","markdown":"---WIKI\r\npage_id: guide-system-html-sse\r\nversion: 6.56\r\nbs_id: system_html_sse\r\n---\r\n\r\n# Verwendung der HTML-API und SSE\r\n\r\nIn dieser Einrichtungshilfe wird beschrieben, wie Sie die HTML-API und SSE der BEHNKE-STATION einrichten und verwenden.\r\n\r\nDie Behnke-Station stellt mit der \r\n\r\n**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.\r\n\r\n**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.\r\n\r\nBeide Schnittstellen sind standardmäßig deaktiviert und müssen vor der Verwendung explizit freigegeben werden. Für den Zugriff ist das **Administrator-Passwort** erforderlich.\r\n\r\n%[NOTE_REQUIRES_BASIC_SETUP](NOTE_REQUIRES_BASIC_SETUP)%\r\n\r\n\r\n> [!TIP]\r\n> 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.\r\n\r\n\r\n## 1. HTML-API und SSE aktivieren\r\n\r\n%[BS_LOGIN_INFO](BS_LOGIN_INFO)%\r\n\r\n- Klicken Sie links in der Seitenleiste auf den Menüpunkt %BS_MENU_SYSTEM%\r\n- Navigieren Sie zum Abschnitt **API**\r\n\r\n\r\n\r\n- Setzen Sie den Wert der Option **Zugriff auf HTML-API** auf den Wert **erlauben**\r\n- Setzen Sie den Wert der Option **Zugriff auf SSE** auf den Wert **erlauben**\r\n- Klicken Sie auf %BS_MENU_SPEICHERN_ROT% um die Konfiguration zu speichern\r\n\r\n\r\n## 2. HTML-API verwenden\r\n\r\nDie 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.\r\n\r\n> [!NOTE]\r\n> Die Verwendung der HTML-API muss zuvor in der Konfiguration der Behnke-Station erlaubt werden. Siehe 1.\r\n\r\nDas allgemeine Schema eines API-Aufrufs lautet:\r\n\r\n```text\r\nhttps://[IP-Adresse]/?key=[Administrator-Passwort]&api=[Befehl]\r\n```\r\n\r\nDabei werden folgende Angaben benötigt:\r\n\r\n- **[IP-Adresse]**: IP-Adresse der Behnke-Station\r\n- **[Administrator-Passwort]**: Administrator-Passwort der Behnke-Station\r\n- **[Befehl]**: auszuführender API-Befehl\r\n- gegebenenfalls weitere Parameter des jeweiligen Befehls\r\n\r\n> [!IMPORTANT]\r\n> Enthält das Administrator-Passwort Sonderzeichen, müssen diese für die Verwendung innerhalb der URL entsprechend **URL-kodiert** werden.\r\n\r\n\r\n### 2.1 API-Befehl erstellen\r\n\r\nZum Erstellen eines gültigen API-Aufrufs kann der integrierte API Command Builder verwendet werden.\r\n\r\n%BS_API_COMMAND_BUILDER%\r\n\r\nDer API Command Builder unterstützt Sie beim Zusammenstellen des Befehls und der benötigten Parameter.\r\n\r\n\r\n### 2.2 API-Aufruf testen\r\n\r\nZum Testen eines API-Aufrufs kann der integrierte API Tester verwendet werden.\r\n\r\n%BS_API_TESTER%\r\n\r\nAlternativ kann ein API-Aufruf direkt über einen Webbrowser oder einen anderen HTTP-Client ausgeführt werden.\r\n\r\nBeispiel für den Aufruf der API-Hilfe:\r\n\r\n```text\r\nhttps://[IP-Adresse]/?key=[Administrator-Passwort]&api=help\r\n```\r\n\r\nÜber den Befehl `help` können weitere Informationen zu den verfügbaren API-Befehlen abgerufen werden.\r\n\r\n> [!TIP]\r\n> Verwenden Sie nach Möglichkeit immer **HTTPS**, damit das Administrator-Passwort und weitere übertragene Daten verschlüsselt übertragen werden.\r\n\r\n# 3. Server-Sent Events (SSE) verwenden\r\n\r\nMit Server-Sent Events kann eine dauerhafte Verbindung zwischen einem Client und der Behnke-Station hergestellt werden.\r\n\r\nNach 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.\r\n\r\n> [!NOTE]\r\n> Die Verwendung von SSE muss zuvor in der Konfiguration der Behnke-Station erlaubt werden.\r\n\r\nFür den Aufbau der Verbindung wird das Administrator-Passwort benötigt.\r\n\r\nDie Verbindung kann über HTTP oder HTTPS aufgebaut werden:\r\n\r\n```text\r\nhttp://[IP-Adresse]:8080/?key=[Administrator-Passwort]&sse\r\n```\r\n\r\nbeziehungsweise:\r\n\r\n```text\r\nhttps://[IP-Adresse]:8443/?key=[Administrator-Passwort]&sse\r\n```\r\n\r\n> [!IMPORTANT]\r\n> Enthält das Administrator-Passwort Sonderzeichen, müssen diese für die Verwendung innerhalb der URL entsprechend **URL-kodiert** werden.\r\n\r\n\r\n### 3.1 SSE-Verbindung testen\r\n\r\nZum Testen der SSE-Schnittstelle kann der integrierte SSE Tester verwendet werden.\r\n\r\n%BS_SSE_TEST%\r\n\r\nNach erfolgreichem Verbindungsaufbau werden von der Behnke-Station übertragene Ereignisse im Tester angezeigt.\r\n\r\n> [!TIP]\r\n> Verwenden Sie nach Möglichkeit die verschlüsselte Verbindung über **HTTPS auf Port 8443**.\r\n\r\n\r\n## 4. HTTP und HTTPS\r\n\r\nFür die HTML-API und SSE sollte grundsätzlich **HTTPS** verwendet werden. Dadurch werden das Administrator-Passwort sowie weitere übertragene Informationen verschlüsselt übertragen.\r\n\r\nHTTP-Verbindungen sind nur möglich, wenn diese über die Einstellung **Webverbindungen** im Bereich **Allgemein** ausdrücklich erlaubt wurden.\r\n\r\n| Schnittstelle | HTTP | HTTPS |\r\n|---|---|---|\r\n| HTML-API | `http://[IP-Adresse]/?...` | `https://[IP-Adresse]/?...` |\r\n| SSE | `http://[IP-Adresse]:8080/?...` | `https://[IP-Adresse]:8443/?...` |\r\n\r\n\r\n## 5. Besonderheit bei Verwendung eines Webcam-VLANs\r\n\r\nFür die HTML-API wird grundsätzlich die IP-Adresse der Behnke-Station verwendet.\r\n\r\nBei 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.\r\n\r\n\r\n## FAQ \r\n\r\n%[NO_CONTENT](NO_CONTENT)%","lastModified":"2026-10-14T13:47:15+02:00"}