Récupérer les niveaux de remplissages de vos conteneurs

Récupérer les niveaux de remplissages de vos conteneurs

Récupérer les niveaux de remplissages de vos conteneurs

Info
Accédez à la documentation complète de l'API V2 sur https://docs.heyliot.app/?api=v2
Notes
On ne parle pas ici de mesure mais bien de niveau de remplissage, depuis le 1er Février 2024, c'est cette donnée "fillLevel" qui est exposé

Récupérer votre identifiant d'organisation

1. Commencez pas récupérer un AccessToken et votre identifant unique ( userId ), vous pouvez suivre ce tutoriel:  V2 - Comment s'authentifier

2. Récupérer votre identifiant d'organization
Utilisez la route  GET  /v2/organizations.

Récupérer tous les niveaux de remplissage par votre organisation

1. Utilisez directement la route  GET  /v2/organizations/{organizationId}/fill_levels.

Exemple de requête pour récupérer les dernièrs niveaux par ordre décroissants depuis le 1er janvier 2023 (UTC) par page de 1000 ( nombre maximum de niveaux par page ).
  GET  /v2/organizations/{organizationId}/itemsPerPage=1000&order[date]=desc&date[gte]=2023-01-01T00:00:00Z

2. Suivez la pagination

Dans le résultat, vous trouverez plusieurs pages, pour paginer, veuillez suivre la page contenue dans ["hydra:view"]["hydra:next"]
Si ce paramètre n'est pas présent, vous êtes donc à la dernière page.



3. Récupérer les données mises à jour

Les données de "fill_levels" sont des données qui peuvent évoluées (être lissées) au cours du temps. Elle vont donc être mises à jour.
L'attribut "updatedAt" vous donnera l'indication de l'heure à laquelle le dernier lissage est passé sur chacune des donnée individuellement.
Si vous souhaitez implémenter une récupération des données les plus lissées ( donc les plus propres ) lors de vos synchronisations, il est recommandé de procéder de la manière suivante:
- A chaque récupération, enregistrer l'heure exacte
- En considérant que H = date de la dernière synchronisation, utiliser une route avec le paramètre updatedAt[gte]=H et ne pas utiliser le paramètre date qui lui se base sur la date de prise de mesure.


Récupérer les données conteneur par conteneur

1. Récupérez vos containers

Utilisez la route  GET  /v2/organizations/{containerId}/containers.


2. Récupérez les niveaux d'un container

Utilisez la route  GET  /v2/containers/{containerId}/fill_levels.

Voici la documentation de cette route, les paramètres sont identiques à la récupération par organizations.

3. Paginez (voir plus haut)




    • Related Articles

    • [DEPRECIÉ] Récupérer les mesures de vos conteneurs

      Cette méthode est dépécié. Veuillez vous rediriger vers la nouvelle documentation: https://heyliot.zohodesk.eu/portal/fr/kb/articles/r%C3%A9cup%C3%A9rer-les-niveaux-de-remplissages-de-vos-conteneurs-16-2-2024 Les routes measures ne seront plus ...
    • Mettre à jour vos identifiants via l'API

      Si vous connaissez vos identifiants actuels 1. Commencez pas récupérer un AccessToken, vous pouvez suivre ce tutoriel: V2 - Comment s'authentifier Si vous ne connaissez pas vos identifiants Si vous avez perdu vos identifiants, veuillez nous ...
    • Récupérer votre identifiant d'organisation

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

      Si vous souhaitez bénéficier d'une authentification par clé API, vous pouvez en faire la demande à votre contact Heyliot. Si vous bénéficiez déjà d'une clé d'API, cette section ne vous concerne pas. Préambule Le système d'authentification d'Heyliot ...