Ce document constitue la documentation technique pour l'API Indaba (V2). Il a pour objectif de vous fournir les informations nécessaires à l'utilisation des différentes ressources et fonctionnalités de l'API.
Toutes les requêtes décrites dans ce document doivent utiliser l'URL de base suivante : xxx.indaba.api.indasuite.io-base.com
Rappel
Avant d'utiliser l'API Indaba, il est important d'avoir en tête la manière dont les données y sont organisées.
Les valeurs sont contenues dans des métriques, elles-mêmes regroupées dans des bases de données (Datasources).
Le stockage de chaque métrique obéit à une règle de stockage qui définit la manière dont les données sont filtrées et enregistrées.
De plus, l'accès à ces données est contrôlé par des autorisations, qui accordent des droits de lecture et/ou d'écriture sur les métriques
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'
Jetons de développement (pour les équipements)
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.