Intégration de l'API
Cette page décrit les conditions requises pour une intégration réussie avec la plateforme et ses différentes applications. Elle est destinée à fournir une vue d'ensemble à nos partenaires intégrateurs.
Les informations de la plateforme sont accessibles par le biais de webhooks et/ou d'interactions avec l'API :
- Les webhooks sont conçus pour recevoir des données en direct de vos capteurs. Voir notre guide sur la configuration des webhooks pour plus d'informations.
- Les appels à l'API peuvent être utilisés pour automatiser les configurations, intégrer de nouvelles capteurs ou configurer les webhooks.
Générer votre token API
Toutes les demandes adressées à l'API doivent être authentifiées à l'aide d'un token. Pour obtenir un token, vous devez le générer à partir de la plateforme intégrateur. Accédez à la vue des développeurs :
Dans l'onglet API Keys, vous pouvez créer un nouveau token. Donnez un nom à votre token, définissez sa portée, et cliquez sur le bouton Create :
Copiez et conservez le token généré dans un endroit sûr. Vous pouvez maintenant l'utiliser pour authentifier vos requêtes.
Authentifier vos requêtes
Pour authentifier une requête, ajoutez l'en-tête HTTP suivant à vos requêtes :
Authorization : Bearer <YOUR_TOKEN>
Environnements
L'API de la plateforme est disponible pour les environnements suivants :
| Environnement | URL de base |
|---|---|
| Test | https://api.staging.viziosense.ai |
| Production | https://api.viziosense.com |
Spécifications du format
- Tous les points de terminaison disponibles dans l'API sont préfixés par
/api/v1. - Tous les points de terminaison acceptent et répondent en JSON.
- Selon la méthode, des en-têtes HTTP sont attendus.
Gestion des exceptions
Les exceptions déclenchées seront renvoyées dans le corps de la réponse HTTP :
| Paramètre | Type | Description |
|---|---|---|
| httpError | Integer | Code d'erreur HTTP |
| message | String | Message user-friendly |
Structure des exceptions
Voici une liste des erreurs qui peuvent être rencontrées :
| Erreur Http | Erreur d'application | Message d'erreur |
|---|---|---|
| 400 | 4000 | Erreur de token d'accès |
| 403 | 4003 | Accès non autorisé |
| 405 | 4005 | Méthode non prise en charge |
| 500 | 5000 | Erreur serveur |