Interroger l’IA du wikiIA

Utilisation de l'API HTML et de SSE

Cette aide à la configuration décrit comment configurer et utiliser l'API HTML et SSE de la BEHNKE-STATION.

La station Behnke met à disposition, avec l'

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.

Les 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.

Les 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.

Il est également supposé que la station Behnke a déjà été intégrée au réseau et qu’elle est accessible via son adresse IP dans un navigateur.

Si vous ne pouvez pas encore accéder à l’interface web, veuillez suivre les instructions fournies avec votre ManuelsCette page ne porte aucune indication de version. Cet avis est généré automatiquement et n’a pas été rédigé par la rédaction. et consulter le manuel techniqueRécemment actualisé — au cours des 72 dernières heuresActualiséCette page ne porte aucune indication de version. Cet avis est généré automatiquement et n’a pas été rédigé par la rédaction. pour effectuer la configuration initiale.

1. Activer l'API HTML et SSE

• Ouvrez votre navigateur
• Accédez à l'interface web de la station Behnke
• Connectez-vous

• Cliquez à gauche, dans la barre latérale, sur l'entrée de menu Système
• Accédez à la section API

• Réglez la valeur de l'option Accès à l'API HTML sur autoriser
• Réglez la valeur de l'option Accès à SSE sur autoriser
• Cliquez sur Enregistrer pour enregistrer la configuration

2. Utiliser l'API HTML

L'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.

Le schéma général d'un appel d'API est le suivant :

https://[IP-Adresse]/?key=[Administrator-Passwort]&api=[Befehl]

Les informations suivantes sont nécessaires :

• [IP-Adresse] : adresse IP de la station Behnke
• [Administrator-Passwort] : mot de passe administrateur de la station Behnke
• [Befehl] : commande API à exécuter
• le cas échéant, d'autres paramètres propres à la commande concernée

2.1 Créer une commande API

Pour créer un appel d'API valide, vous pouvez utiliser l'API Command Builder intégré.

L'API Command Builder vous aide à composer la commande et les paramètres nécessaires.

2.2 Tester un appel d'API

Pour tester un appel d'API, vous pouvez utiliser l'API Tester intégré.

Vous pouvez également exécuter un appel d'API directement depuis un navigateur web ou un autre client HTTP.

Exemple d'appel de l'aide de l'API :

https://[IP-Adresse]/?key=[Administrator-Passwort]&api=help

La commande help permet d'obtenir des informations supplémentaires sur les commandes API disponibles.

3. Utiliser les Server-Sent Events (SSE)

Les Server-Sent Events permettent d'établir une connexion permanente entre un client et la station Behnke.

Une 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.

Le mot de passe administrateur est nécessaire pour établir la connexion.

La connexion peut être établie en HTTP ou en HTTPS :

http://[IP-Adresse]:8080/?key=[Administrator-Passwort]&sse

ou :

https://[IP-Adresse]:8443/?key=[Administrator-Passwort]&sse

3.1 Tester la connexion SSE

Pour tester l'interface SSE, vous pouvez utiliser le SSE Tester intégré.

Une fois la connexion établie avec succès, les événements transmis par la station Behnke s'affichent dans le testeur.

4. HTTP et HTTPS

Pour 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.

Les 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.

5. Particularité en cas d'utilisation d'un VLAN webcam

Pour l'API HTML, c'est en principe l'adresse IP de la station Behnke qui est utilisée.

Pour 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.

FAQ

Cette section ne contient actuellement aucun contenu.