Cette collection d'articles constitue la documentation technique pour l'API IndaMeta (V2). Il a pour objectif de vous fournir les informations nécessaires à l'utilisation des différentes ressources liées aux fonctionnalités d'IndaMeta (arborescences fonctionnelles).
Toutes les requêtes décrites dans cette collection doivent utiliser l'URL de base suivante : https://xxx.indaba.api.indasuite.io-base.com
Rappel
Avant d'utiliser l'API IndaMeta, il est important d'avoir en tête le fonctionnement des arborescences fonctionnelles dans Io-base.
Les arborescences fonctionnelles permettent d'organiser vos métriques de manière hiérarchique afin de les retrouver plus facilement.
Une arborescence est composée de plusieurs types d'éléments, qui peuvent être des dossiers ou des métriques.
Chaque type d'élément peut avoir des propriétés personnalisées et des modèles de métriques ou de formules pour générer des métriques de manière dynamique.
Si vous n'êtes pas familiers avec ces notions, référez-vous à la documentation IndaMeta.
Authentification
Toute interaction avec les API Io-base requiert une authentification reposant sur un jeton d'accès (JWT).
Ce jeton doit être inclus dans l'en-tête "Authorization" de chaque requête en utilisant le type "Bearer".
Exemple :
# Commande pour appeler un endpoint de l'API avec l'authentification
# Remplacez VOTRE_JETON_JWT par le jeton que vous avez récupéré.
curl -X GET 'https://xxx.indaba.api.indasuite.io-base.com/v2/metrics' \
-H 'Authorization: Bearer VOTRE_JETON_JWT'
Obtention d'un jeton d'accès
Pour permettre à une application, un service ou un script de communiquer avec l'API Indaba, vous devez utiliser un "access token".
Ce jeton est généré via une procédure sécurisée gérée par le Device Access Proxy (DAP). Les droits (read, write) conférés par ce jeton ne sont pas liés à un utilisateur physique, mais à un compte de service.
Pour plus de détails, se référer à la procédure d'authentification via le DAP.
Note : Il vous est possible d'utiliser un jeton d'accès de développement (voir documentation correspondante).
Dans ce cas, ce jeton doit être inclus dans l'en-tête "Authorization" de chaque requête en utilisant le type "Token".
Exemple :
# Commande pour appeler un endpoint de l'API avec l'authentification
# Remplacez VOTRE_JETON_JWT par le jeton que vous avez récupéré.
curl -X GET 'https://xxx.indaba.api.indasuite.io-base.com/v2/metrics' \
-H 'Authorization: Token VOTRE_JETON_JWT'
Jetons utilisateur (console API)
Lorsque vous êtes connectés au portail de Io-base, vous pouvez requêter l'API depuis la console API.
Lors de l'authentification, le jeton utilisé possède les droits (scopes) et autorisations sur les métriques de votre compte utilisateur Io-base.