Skip to main content

Introduction and key concepts

Updated over 2 weeks ago

This document is the technical documentation for the Indaba API (V2). It provides the necessary information to use the various resources and features of the API.

All requests described in this document must use the following base URL: xxx.indaba.api.indasuite.io-base.com.

Key Concepts

Before using the Indaba API, it is important to understand how its data is organized.

Values are contained in metrics, which are themselves grouped into databases (Datasources).

The storage of each metric is governed by a storage rule that defines how data is filtered and recorded.

Furthermore, access to this data is controlled by authorizations, which grant read and/or write rights on the metrics.

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'

Development Tokens (for devices)

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 (for web interfaces)

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.

Did this answer your question?