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 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 n'est plus valide, vous recevrez une 401 . Il faudra donc utiliser le RefreshToken ou vous authentifier de nouveau pour en récupérer un.

Pour savoir utiliser l'ensemble des routes, vous pouvez consulter la documentation: https://docs.heyliot.app/?api=auth

Le nom de domaine à utiliser est https://auth.heyliot.app

Route d'authentification

Pour s'authentifier, utilisez la route  POST   /authenticate .

Voici un exemple d'usage avec Postman :

Vérifier son authentification et récupérer son identifiant unique (userId)

Pour vérifier la validité de votre AccessToken, utilisez la route    POST    /authorize .

Voici un exemple d'usage avec Postman :

Aller plus loin

Pour créer un système complet, 2 routes supplémentaires sont à votre disposition:

-   POST  /refresh vous permet de générer un nouvel AccessToken à partir de votre RefreshToken

-   POST  /revoke vous permet de révoquer votre AccessToken à partir de votre RefreshToken

• Related Articles

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

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

• [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 ...

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

  Récupérer les niveaux de remplissages de vos conteneurs Accédez à la documentation complète de l'API V2 sur https://docs.heyliot.app/?api=v2 On ne parle pas ici de mesure mais bien de niveau de remplissage, depuis le 1er Février 2024, c'est cette ...