Heyliot

Comment récupérer les données des capteurs dans son application ? (mode PULL)

Dans ce document, nous présenterons comment récupérer les données des capteurs via notre plateforme et notre API REST.

Cela vous permettra d’intégrer ces données dans votre propre application métier.


En mode PULL, c'est à votre application d'interroger notre API pour récupérer régulièrement les données de capteurs.
A l'inverse, en mode PUSH, c'est notre API qui transmet des données à votre application ; cet usage n'est pas couvert dans cet article.

Pour ce faire nous allons découper le processus en plusieurs étapes :

-       Connexion à la plateforme

-       Générer son token API

-       Première requête à l’API

-       Récupérer les groupes via l’API

-       Récupération les capteurs d’un groupe

-       Récupérer les détails d’un capteur

-       Récupérer les payloads d’un capteur


1- Connexion à la plate-forme

Se connecter sur l'application Heyliot : https://app.heyliot.com : 



Saisir les identifiants qui vous ont été fournis. Et cliquer sur [Se connecter]

2- Générer un token API

Une fois connecté, cliquez en haut à droit sur [Profil] ou [Edit Profile]




Votre token personnel est stocké dans le champ "Api token", copiez ce token dans un endroit sûr.




/ ! \ ATTENTION : Si le token est perdu / usurpé, veuillez cliquer sur « Régénérer API token » dans les plus brefs délais !

3- Première requête à l'API

Nous allons simuler votre application-métier en utilisant Postman. Cet outil permet notamment l'envoi de requêtes HTTP à une API.
URL de l'API REST : https://api.heyliot.com/v1
Dans le header, ajouter un champ "x-access-token" et mettre en valeur le token précédemment copié.



Vous pouvez effectuer la même requête pour vous permettre de vérifier le bon fonctionnement de votre token.


4 - Récupérer les groupes via l’API 

Pour récupérer la liste des groupes de capteurs il faut requêter l'API en méthode "GET" ainsi qu'utiliser l'URL suivante : https://api.heyliot.com/v1/get-groups
Dans le header, ajouter un champ "x-access-token" et mettre en valeur le token précédemment copié.





En réponse vous obtiendrez un tableau d'objets JSON.
Voici un exemple de l'objet :

 

Vous obtiendrez ainsi une liste de groupes ainsi que les groupes parents.




5 - Récupérer les capteurs d’un groupe 

Pour récupérer la liste des capteurs il faut requêter l'API en méthode "GET" ainsi qu'utiliser l'URL suivante : https://api.heyliot.com/v1/devices
Dans le header, ajouter un champ "x-access-token" et mettre en valeur le token précédemment copié.




En réponse vous obtiendrez un tableau d'objets JSON.
Voici un exemple de l'objet :




Vous obtiendrez ainsi une liste de capteurs ainsi que leurs groupes associés.



6 - Récupérer les détails d’un capteur 

Pour récupérer la liste des capteurs il faut requêter l'API en méthode "GET" ainsi qu'utiliser l'URL suivante : https://api.heyliot.com/v1/devices/{ID DE VOTRE CAPTEUR}
Dans le header, ajouter un champ "x-access-token" et mettre en valeur le token précédemment copié.





En réponse vous obtiendrez un objet JSON. (voir le dernier objet JSON présenté)
Vous obtiendrez ainsi les détails d’un capteur ainsi que son groupe associé.

7- Récupérer les détails du capteur avec son niveau de remplissage et dernier paylaod

Pour récupérer les informations synthétisé du capteur il faut requêter l'API en méthode "GET" ainsi qu'utiliser l'URL suivante : https://api.heyliot.com/external/device/{ID DE VOTRE CAPTEUR}
Dans le header, ajouter un champ "x-access-token" et mettre en valeur le token précédemment copié.



En réponse vous obtiendrez un objet JSON. (voir le dernier objet JSON présenté)
Vous obtiendrez ainsi les informations synthétisé d’un capteur ainsi que son groupe associé.

8 - Récupérer les payloads d’un capteur 

Pour récupérer la liste des capteurs il faut requêter l'API en méthode "GET" ainsi qu'utiliser l'URL suivante : https://api.heyliot.com/v1/payloads/{ID DE VOTRE CAPTEUR}/{TYPE DE PAYLOADS}/{DATE DE DEBUT}/{DATE DE FIN}

Pour informations, il y'a 2 types de payloads :
       -        « 1 » Ce type de payloads correspond aux mesures
       -        « 0 » Ce type de mesures correspond aux calibrations

Pour finir les DATES doivent être fournis en format UTC+0

Dans le header, ajouter un champ "x-access-token" et mettre en valeur le token précédemment copié.




Après exécution de la requête vous obtiendrez tout les payloads du type demandé entre les 2 périodes précisées.

En réponse vous obtiendrez un tableau d'objets JSON.
Voici un exemple de l'objet :






8 - Allez plus loin

L'ensemble des routes API disponibles sont documentées ici : https://api.heyliot.com/docs/












    • Related Articles

    • Récupérer les mesures de vos conteneurs

      Accédez à la documentation complète de l'API V2 sur https://docs.heyliot.com/?api=v2 Récupérer les mesures de vos conteneurs 1. Commencez pas récupérer un AccessToken et votre identifant unique ( userId ), vous pouvez suivre ce tutoriel:  V2 - ...
    • Comment s'authentifier

        Préambule Le système d'authentification d'Heyliot est basé sur des AccessToken et des RefreshToken . Un AccessToken sera passé dans chaque requête dans le header Authorization , sa validité sera vérifiée à chaque requête. Lorsqu'un AccessToken ...
    • Mettre à jour vos identifiants via l'API

      Accédez à la documentation complète de l'API V2 sur https://docs.heyliot.com/?api=v2 Si vous connaissez vos identifiants actuels 1. Commencez pas récupérer un AccessToken et votre identifant unique ( userId ), vous pouvez suivre ce tutoriel:  V2 - ...
    • Comment allumer / éteindre / changer la pile / faire une mesure manuelle avec le capteur ?

    • Préconisations d'installation

      Vous trouverez en pièce-jointe un document présentant les préconisations d'installation du capteur Heywaste.