Passer au contenu principal
Documentation API Holaspirit

En savoir plus sur comment accéder et utiliser l'API Holaspirit

Philippe Pinault avatar
Écrit par Philippe Pinault
Mis à jour il y a plus d'un an

👉 L'accès API est inclus dans les plans Scale et Enterprise. En savoir plus !

Holaspirit est basé sur une API REST ouverte pour des intégrations sans limites avec vos applications web.

Une version détaillée sur l'utilisation de l'API Holaspirit est disponible sur GitHub : https://github.com/holaSpirit/holaspirit-docs/blob/master/api.md


Documentation API Holaspirit

🔗 Accéder à toutes les ressources relatives à notre API :

🔗 Consultez le guide de l'API des développeurs de Holaspirit : un manuel de référence contenant toutes les informations dont vous avez besoin pour démarrer :

🔗 Consultez notre document sur les enpoints de l'API pour obtenir des détails sur tous les endpoints :

🔗 S'abonner à notre Changelog pour rester au courant de toutes les modifications de l'API :

Comment être informé des modifications relatives à l'API ?

Pour recevoir des notifications (par email et sur Github) concernant les modifications que nous apportons à notre API, vous pouvez vous abonner à notre changelog :


Obtenir un token API

👤 Seuls les administrateurs peuvent créer une clé API.

Pour générer une clé API :

  • Allez dans les paramètres d'Administration

  • Trouvez la section API

  • Cliquez sur Créer une clé

  • Saisissez le nom de votre clé

  • Cliquez sur Créer

Votre clé API est prête à être copié et utilisé pour vous connecter à un outil tiers.


Clé d'accès read-only

Une fois que vous avez obtenu une clé d'accès en lecture seule, vous pouvez l'utiliser pour toutes vos demandes GET, elle n'expire jamais.


Clé d'accès read-write

Avant que votre application ne puisse accéder aux données Holaspirit, elle doit obtenir une clé d'accès qui lui donne accès à l'API.


Parameters

client_id: Required OAuth2 Client ID
client_secret: OAuth2 Client secret
grant_type: OAuth2 grant
type: "password" or "refresh_token"
username: Email
password: Password
timezone: Timezone (e.g.: "+02:00") 

The client secret is not required for a public app.

The default and public Client ID is: 54cb79d0279871e1248b4567_400tdzqbdcowsskk08gws0wkwogck00w084w4s8w8gok08s0o8.


Response

{
    "access_token": "#################",
    "expires_in": 3600,
    "token_type": "bearer",
    "scope": null,
    "refresh_token": "#################"
}


Response errors

Incorrect Client ID (status code: 400):

{
    "error": "invalid_client",
    "error_description": "The client credentials are invalid"
}

Incorrect credentials (status code: 400):

{
    "error": "invalid_grant",
    "error_description": "Invalid username and password combination"
}


Endpoints

Une fois authentifié, vous pouvez utiliser tous les endpoints définis dans la documentation :

Avez-vous trouvé la réponse à votre question ?