Introduction
This document is the technical documentation for the IndaMeta API (V2). It aims to provide you with the necessary information to use the various resources related to IndaMeta's features (functional trees).
All requests described in this collection must use the following base URL: https://xxx.indaba.api.indasuite.io-base.com
Key Concepts
Before using the IndaMeta API, it is important to understand how functional trees work in Io-base.
Functional trees allow you to organize your metrics hierarchically to find them more easily.
A tree is composed of several item types, which can be either folders or metrics.
Each item type can have custom properties and metric or formula templates to dynamically generate metrics.
If you are not familiar with these concepts, please refer to the IndaMeta documentation.
Authentication
Every interaction with the Io-base APIs requires authentication using an access token (JWT).
This token must be included in the Authorization header of each request, using the Bearer type.
Example :
# Command to call an API endpoint with authentication
# Replace YOUR_JWT_TOKEN with the token you have retrieved.
curl -X GET 'https://xxx.indaba.api.indasuite.io-base.com/v2/metrics' \
-H 'Authorization: Bearer VOTRE_JETON_JWT'
Obtaining an Access Token
To allow an application, service, or script to communicate with the Indaba API, you must use an access token.
This token is generated through a secure procedure managed by the Device Access Proxy (DAP). The rights (read, write) granted by this token are not linked to a physical user, but to a service account.
For more details, please refer to the authentication procedure via the DAP.
Note : It is also possible to use a development access token (see the corresponding documentation).
In this case, this token must be included in the Authorization header of each request using the Token type.
Example :
# Command to call an API endpoint with authentication
# Replace YOUR_JWT_TOKEN with the token you have retrieved.
curl -X GET 'https://xxx.indaba.api.indasuite.io-base.com/v2/metrics' \
-H 'Authorization: Token VOTRE_JETON_JWT'
User Tokens
When you are logged in Io-base, you can use the API console.
The token used for authentication possesses the same rights (scopes) and permissions on metrics as your own Io-base user account.