La majorité des services en ligne, et désormais des équipements, proposent désormais leurs données sous forme d'API. La GTB ayant un rôle fédérateur, il est souvent très intéressant d’agréger ces données proposées pour les coupler aux données terrains :
Compteurs sans-fils Sigfox
Pics de consommation PP1 et PP2 de RTE
Qualité de l'air de BreezoMeter
Météo de DarkSky
Ventilo-convecteurs de Distech
etc.
Qu'est-ce qu'une API ?
Une API (Interface de Programmation Applicative) est entre autre un ensemble normalisé de fonctions qui sert de façade par laquelle un logiciel offre des services à d'autres logiciels. Il existe des API logicielle (Niagara dispose de nombreuses API) et des API Web (RTE, Sigfox etc.) aussi appelées WebService. Les APIs sont le plus souvent accompagnées d'une description qui spécifie comment utiliser ces fonctions.
Les API Web permettent aujourd'hui de facilement échanger des informations entre applications et de fournir un meilleur service.
Pourquoi le RestNetwork ?
Le contenu des APIs n'étant pas standardisé, il était indispensable jusqu'à maintenant d'avoir recours à un développement spécifique pour communiquer avec chaque API. Il fallait interpréter "en dur" les données reçues de ces APIs pour les transformer dans Niagara de manière utilisable (points, historiques, programmes horaires etc.). Même l'interprétation des données transmises par des capteurs Sigfox est différente selon le constructeur et nécessitait pour chacun d'entre eux un développement spécifique.
C'est pour démocratiser l'accès aux APIs dans Niagara que nous avons lancé le driver RestNetwork, disponible uniquement en lecture aujourd'hui. Il permet de transformer des informations d'une API, quelque soit le contenu au format JSON, en équipements et points dans Niagara. Il permet de gérer l'interprétation des données de manière dynamique à l'aide de programmation par blocs d'objet des conversion pour transformer le JSON en valeur ou état.
Le Driver a été conçu de manière très dynamique permettant facilement de récupérer des données d'une API pour accéder à une autre et de convertir tout type de données dans le JSON en valeur.
Documentation
Toute la documentation du RestNetwork est disponible ici ou en faisant un clic droit sur les composants du module dans le Workbench. Nous en avons profité pour faire une documentation générale sur le protocole HTTP et les API Web disponible ici.
Exemples
Nous avons intégré directement dans le module des exemples d'utilisation du module avec des services comme RTE, la RATP, Sigfox et notamment un exemple de conversion des équipements Adeunis, Darksky Weather et BreezoMeter. Tous ces exemples sont fonctionnels et vous permettrons de vous faire la main.
Accompagnement
Vous avez une API avec laquelle communiquer ? Les notions de REST et de format JSON sont floues ? Nous pouvons vous accompagner dans la mise en place du Driver et des conversions de données.
Disponibilité
Le driver est téléchargeable ici. Il est disponible gratuitement pour l'instant en beta. La licence est décomposée par pack de points (5, 10, 100, illimité).
Breadcrumbs
Lancement du RestNetwork pour communiquer avec des API
La majorité des services en ligne, et désormais des équipements, proposent désormais leurs données sous forme d'API. La GTB ayant un rôle fédérateur, il est souvent très intéressant d’agréger ces données proposées pour les coupler aux données terrains :
Qu'est-ce qu'une API ?
Une API (Interface de Programmation Applicative) est entre autre un ensemble normalisé de fonctions qui sert de façade par laquelle un logiciel offre des services à d'autres logiciels. Il existe des API logicielle (Niagara dispose de nombreuses API) et des API Web (RTE, Sigfox etc.) aussi appelées WebService. Les APIs sont le plus souvent accompagnées d'une description qui spécifie comment utiliser ces fonctions.
Les API Web permettent aujourd'hui de facilement échanger des informations entre applications et de fournir un meilleur service.
Pourquoi le RestNetwork ?
Le contenu des APIs n'étant pas standardisé, il était indispensable jusqu'à maintenant d'avoir recours à un développement spécifique pour communiquer avec chaque API. Il fallait interpréter "en dur" les données reçues de ces APIs pour les transformer dans Niagara de manière utilisable (points, historiques, programmes horaires etc.). Même l'interprétation des données transmises par des capteurs Sigfox est différente selon le constructeur et nécessitait pour chacun d'entre eux un développement spécifique.
C'est pour démocratiser l'accès aux APIs dans Niagara que nous avons lancé le driver RestNetwork, disponible uniquement en lecture aujourd'hui. Il permet de transformer des informations d'une API, quelque soit le contenu au format JSON, en équipements et points dans Niagara. Il permet de gérer l'interprétation des données de manière dynamique à l'aide de programmation par blocs d'objet des conversion pour transformer le JSON en valeur ou état.
Le Driver a été conçu de manière très dynamique permettant facilement de récupérer des données d'une API pour accéder à une autre et de convertir tout type de données dans le JSON en valeur.
Documentation
Toute la documentation du RestNetwork est disponible ici ou en faisant un clic droit sur les composants du module dans le Workbench. Nous en avons profité pour faire une documentation générale sur le protocole HTTP et les API Web disponible ici.
Exemples
Nous avons intégré directement dans le module des exemples d'utilisation du module avec des services comme RTE, la RATP, Sigfox et notamment un exemple de conversion des équipements Adeunis, Darksky Weather et BreezoMeter. Tous ces exemples sont fonctionnels et vous permettrons de vous faire la main.
Accompagnement
Vous avez une API avec laquelle communiquer ? Les notions de REST et de format JSON sont floues ? Nous pouvons vous accompagner dans la mise en place du Driver et des conversions de données.
Disponibilité
Le driver est téléchargeable ici. Il est disponible gratuitement pour l'instant en beta. La licence est décomposée par pack de points (5, 10, 100, illimité).
-
Files and images
-
Link
-
Markup
-
Horizontal rule
-
Date
-
Emoticon
-
Symbol
Insert macro