Authentification, Gestion de Compte et Fonctionnalités

1 Récupération d'un PAT
2 Gérer son compte et récupération du namespace (API de compte)
3 Cibler un namespace pour l'utilisation des APIs de gestion
4 Utiliser une fonctionnalité (API de gestion)
5 Liste des différentes fonctionnalités proposés

Récupération d'un PAT

Les APIs sont uniquement accessibles aux utilisateurs authentifiés via un Personal Access Token (PAT), qui doit être inclus dans chaque requête pour permettre l'identification.

Dans la version actuelle de l'API, le PAT est délivré directement par l'équipe de support Baleen. Pour toute nouvelle demande, veuillez ouvrir un ticket en contactant le support via ce lien : Contacter le Support Baleen

Gérer son compte et récupération du namespace (API de compte)

Les APIs de compte requièrent uniquement le PAT pour fonctionner.

L'accès à l'endpoint /api/account permet non seulement de récupérer les informations de compte, mais aussi de lister les namespaces disponibles, indiquant ainsi les environnements Baleen sur lesquels des actions peuvent être menées.

Exemple de requête :

curl https://console.baleen.cloud/api/account -H "X-Api-Key: <PAT>"

La réponse contiendra la liste des namespaces disponibles pour cet utilisateur. Il est nécessaire d’extraire la clé associée au souhaité :

{ 
   "id" : "ab72be83-2453-42d7-90dc-5406384b21e4", 
   "login" : "admin_integration@cshield.tech", 
   "firstName" : "Admin", 
   "lastName" : "Integration", 
   "email" : "admin_integration@cshield.tech", 
   "activated" : true, 
   "langKey" : "en", 
   "createdDate" : "2020-09-14T14:06:38.702553Z", 
   "lastModifiedDate" : "2020-09-14T14:06:38.702559Z",
   "authorities" : [ "ROLE_USER", "ROLE_ADMIN" ],
   "namespaces" : { 
      "z9FSxMAA36O/Id0A9sfqIw==" : "Demo", 
      "PC5EASWiddi1cRGnxOPyGA==" : "Multipop" 
   } 
}

Cibler un namespace pour l'utilisation des APIs de gestion

Une fois la clé du namespace récupérée, il faut la transmettre dans un cookie de session sous la forme suivante :

baleen-namespace=<namespace-key>

Si ce cookie n’est pas spécifié, les requêtes faites aux APIs de gestion ne seront pas prises en compte par le système.

Exemple :

Remarque : Il est crucial de passer par cette requête /api/account pour obtenir le namespace, car pour des raisons de sécurité, cette chaîne peut varier.

Cependant, cette variation est relativement peu fréquente et peut être gérée en mode "fallback".

Utiliser une fonctionnalité (API de gestion)

À la différence des APIs de compte, les APIs de gestion requièrent non seulement le PAT, mais aussi des informations de contexte (namespace) ainsi que la spécification d'une fonctionnalité.

Le chemin à utiliser pour ces requêtes est : /api/nom-fonctionnalité.

Exemple :

Liste des différentes fonctionnalités proposés

Un utilisateur de Baleen peut accéder aux APIs pour :