{"wiki":"fr","slug":"guide-system-html-sse","markdown":"# Utilisation de l'API HTML et de SSE\n\nCette aide à la configuration décrit comment configurer et utiliser l'API HTML et SSE de la BEHNKE-STATION.\n\nLa station Behnke met à disposition, avec l'\n\n**API HTML** et les **Server-Sent Events (SSE)**, deux interfaces d'accès via le réseau. L'**API HTML** permet de consulter et de modifier les paramètres de la station Behnke, ainsi que de déclencher certains événements. La communication s'effectue au moyen de requêtes HTTP ou HTTPS.\n\nLes **Server-Sent Events (SSE)**, en revanche, permettent une connexion permanente entre un client et la station Behnke. Grâce à cette connexion, la station peut transmettre immédiatement au client connecté les événements qui se produisent, par exemple les appuis de touches détectés.\n\nLes deux interfaces sont désactivées par défaut et doivent être explicitement autorisées avant toute utilisation. Le **mot de passe administrateur** est requis pour y accéder.\n\n%[NOTE_REQUIRES_BASIC_SETUP](NOTE_REQUIRES_BASIC_SETUP)%\n\n\n> [!TIP]\n> Tous les outils intégrés dans cet article du wiki fonctionnent EXCLUSIVEMENT avec **HTTPS**. Avant de pouvoir utiliser ces outils, vous devez visiter l'interface web de l'appareil avec ce terminal et accepter l'avertissement relatif au certificat.\n\n\n## 1. Activer l'API HTML et SSE\n\n%[BS_LOGIN_INFO](BS_LOGIN_INFO)%\n\n- Cliquez à gauche, dans la barre latérale, sur l'entrée de menu %BS_MENU_SYSTEM%\n- Accédez à la section **API**\n\n\n\n- Réglez la valeur de l'option **Accès à l'API HTML** sur **autoriser**\n- Réglez la valeur de l'option **Accès à SSE** sur **autoriser**\n- Cliquez sur %BS_MENU_SPEICHERN_ROT% pour enregistrer la configuration\n\n\n## 2. Utiliser l'API HTML\n\nL'API HTML permet d'appeler des fonctions de la station Behnke au moyen de requêtes HTTP ou HTTPS. Selon la commande API utilisée, il est possible de consulter des informations, de modifier des paramètres ou de déclencher des actions.\n\n> [!NOTE]\n> L'utilisation de l'API HTML doit d'abord être autorisée dans la configuration de la station Behnke. Voir le point 1.\n\nLe schéma général d'un appel d'API est le suivant :\n\n```text\nhttps://[IP-Adresse]/?key=[Administrator-Passwort]&api=[Befehl]\n```\n\nLes informations suivantes sont nécessaires :\n\n- **[IP-Adresse]** : adresse IP de la station Behnke\n- **[Administrator-Passwort]** : mot de passe administrateur de la station Behnke\n- **[Befehl]** : commande API à exécuter\n- le cas échéant, d'autres paramètres propres à la commande concernée\n\n> [!IMPORTANT]\n> Si le mot de passe administrateur contient des caractères spéciaux, ceux-ci doivent être **encodés en URL** de manière appropriée pour pouvoir être utilisés dans l'URL.\n\n\n### 2.1 Créer une commande API\n\nPour créer un appel d'API valide, vous pouvez utiliser l'API Command Builder intégré.\n\n%BS_API_COMMAND_BUILDER%\n\nL'API Command Builder vous aide à composer la commande et les paramètres nécessaires.\n\n\n### 2.2 Tester un appel d'API\n\nPour tester un appel d'API, vous pouvez utiliser l'API Tester intégré.\n\n%BS_API_TESTER%\n\nVous pouvez également exécuter un appel d'API directement depuis un navigateur web ou un autre client HTTP.\n\nExemple d'appel de l'aide de l'API :\n\n```text\nhttps://[IP-Adresse]/?key=[Administrator-Passwort]&api=help\n```\n\nLa commande `help` permet d'obtenir des informations supplémentaires sur les commandes API disponibles.\n\n> [!TIP]\n> Utilisez si possible toujours **HTTPS**, afin que le mot de passe administrateur et les autres données transmises soient chiffrés.\n\n# 3. Utiliser les Server-Sent Events (SSE)\n\nLes Server-Sent Events permettent d'établir une connexion permanente entre un client et la station Behnke.\n\nUne fois la connexion établie, elle reste ouverte. La station Behnke peut ainsi transmettre immédiatement au client connecté les événements qui se produisent. Il peut s'agir, par exemple, d'appuis de touches détectés ou d'autres événements de la station.\n\n> [!NOTE]\n> L'utilisation de SSE doit d'abord être autorisée dans la configuration de la station Behnke.\n\nLe mot de passe administrateur est nécessaire pour établir la connexion.\n\nLa connexion peut être établie en HTTP ou en HTTPS :\n\n```text\nhttp://[IP-Adresse]:8080/?key=[Administrator-Passwort]&sse\n```\n\nou :\n\n```text\nhttps://[IP-Adresse]:8443/?key=[Administrator-Passwort]&sse\n```\n\n> [!IMPORTANT]\n> Si le mot de passe administrateur contient des caractères spéciaux, ceux-ci doivent être **encodés en URL** de manière appropriée pour pouvoir être utilisés dans l'URL.\n\n\n### 3.1 Tester la connexion SSE\n\nPour tester l'interface SSE, vous pouvez utiliser le SSE Tester intégré.\n\n%BS_SSE_TEST%\n\nUne fois la connexion établie avec succès, les événements transmis par la station Behnke s'affichent dans le testeur.\n\n> [!TIP]\n> Utilisez si possible la connexion chiffrée via **HTTPS sur le port 8443**.\n\n\n## 4. HTTP et HTTPS\n\nPour l'API HTML et SSE, il convient en principe d'utiliser **HTTPS**. Le mot de passe administrateur ainsi que les autres informations transmises sont ainsi chiffrés.\n\nLes connexions HTTP ne sont possibles que si elles ont été expressément autorisées via le paramètre **Connexions web** dans la section **Général**.\n\n| Interface | HTTP | HTTPS |\n|---|---|---|\n| API HTML | `http://[IP-Adresse]/?...` | `https://[IP-Adresse]/?...` |\n| SSE | `http://[IP-Adresse]:8080/?...` | `https://[IP-Adresse]:8443/?...` |\n\n\n## 5. Particularité en cas d'utilisation d'un VLAN webcam\n\nPour l'API HTML, c'est en principe l'adresse IP de la station Behnke qui est utilisée.\n\nPour SSE, une particularité s'applique : si un VLAN distinct est configuré pour la webcam dans la section **Réseau**, c'est l'adresse IP de la webcam qui doit être utilisée pour la connexion SSE.\n\n\n## FAQ \n\n%[NO_CONTENT](NO_CONTENT)%\n","lastModified":"2026-10-14T13:47:15+02:00"}