Général - Utiliser les APIs

Fonctionnalités

Un utilisateur Baleen peut utiliser les APIs Baleen :

• Gérer son compte (API de compte)

• Utiliser une fonctionnalité (API de gestion)

• Liste des fonctionnalités

Pour cela, l'utilisateur va devoir récupérer un "Personal Access Token" (ou PAT)

Récupérer un PAT

Les APIs sont uniquement accessibles pour les utilisateurs authentifiés.
Nous avons choisi d'utiliser le principe de "Personal Access Token" (ou PAT) pour cela. Vous aurez donc à disposition un token à passer dans chaque requête, et permettant de vous identifier.
Dans la version courante de l’API, le PAT vous sera transmis directement par l’équipe de support Baleen.

Gérer son compte

Les APIs de compte ne nécéssite que d'avoir le PAT pour être utilisées.

Il sera possible d'accéder aux informations de compte via le chemin: /api/account.

Exemple :

Utiliser une fonctionnalité

A la différence des APIs de compte, les APIs de gestion nécessitent, en plus du PAT, une information de contexte (namespace), pour savoir sur quelle instance de Baleen faire la modification (certains clients peuvent avoir plusieurs instances).

Le chemin à utiliser sera : /api/nom-fonctionnalité.

Exemple

Il est donc nécéssaire de passer par une API de compte pour récupérer ce namespace.

Récupération du namespace

Pour récupérer le namespace à utiliser pour les requêtes suivantes, il faut faire une requête sur "/api/account" :

Dans la réponse, vous aurez la liste des namespaces disponibles pour cet utilisateur. Il faut récupérer la clé associée au namespace voulu :

Notes : Il est important de bien passer par cette requête '/api/account' pour récupérer le namespace, car, pour des raisons de sécurité, cette chaine pourra varier. Cette variation étant néanmoins relativement peu fréquente, cet appel peut être fait en mode "fallback".

Cibler un namespace dans l’utilisation des API de gestion

Une fois la clé du namespace récupérée il faut la passer dans un cookie de session.

Si ce cookie n’est pas renseigné, les demandes faites à l’API de gestion ne seront pas prises en compte par le produit.

Exemple :

Liste fonctionnalités disponibles