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