Fonctionnalités
Un utilisateur Baleen peut utiliser les APIs Baleen :
Gérer son compte (API de compte)
Utiliser une fonctionnalité (API de gestion)
Pour cela, l'utilisateur va devoir récupérer un "Personal Access Token" (ou PAT)
...
| Table of Contents | ||
|---|---|---|
|
Récupération d'un PAT
Les APIs sont uniquement accessibles pour les aux utilisateurs authentifiés .
Nous avons choisi d'utiliser le principe de "via un Personal Access Token " (ou PAT) pour cela. Vous aurez donc à disposition un token à passer dans chaque requête, et permettant de vous identifier, qui doit être inclus dans chaque requête pour permettre l'identification.
Dans la version courante actuelle de l’APIl'API, le PAT vous sera transmis est délivré directement par l’équipe 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 ne nécéssite que d'avoir requièrent uniquement le PAT pour être utiliséesfonctionner.
Il sera possible d'accéder aux informations de compte via le chemin: /api/account.
Exemple :
| Code Block |
|---|
`curl https://console.baleen.cloud/api/account -H "X-Api-Key: <PAT>"` |
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
| Code Block |
|---|
curl -X POST https://console.baleen.cloud/api/nom-fonctionnalité
-H "X-Api-Key: <PAT>"
... |
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" 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 :
| Code Block |
|---|
curl https://console.baleen.cloud/api/account -H "X-Api-Key: <PAT>" |
Dans la réponse, vous aurez La réponse contiendra la liste des namespaces disponibles pour cet utilisateur. Il faut récupérer est nécessaire d’extraire la clé associée au namespace voulu souhaité :
| Code Block | ||
|---|---|---|
| ||
{
"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 passer transmettre dans un cookie de session .sous la forme suivante :
| Code Block |
|---|
baleen-namespace=<namespace-key> |
Si ce cookie n’est pas renseignéspécifié, les demandes requêtes faites à l’API aux APIs de gestion ne seront pas prises en compte par le produitsystème.
Exemple :
| Code Block |
|---|
curl -X POST https://console.baleen.cloud/api/nom-fonctionnalité -H "X-Api-Key: <PAT>" --cookie "baleen-namespace=<namespace-key>" ... } |
Liste fonctionnalités disponibles
...
Nom de la fonctionnalité
...
API
...
Liens page
...
Invalider une ressource
...
/api/cache/invalidations
...
Utiliser les APIs d'invalidation de cache
...
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 :
| Code Block |
|---|
curl -X POST https://console.baleen.cloud/api/nom-fonctionnalité -H "X-Api-Key: <PAT>" ... |
Liste des différentes fonctionnalités proposés
Un utilisateur de Baleen peut accéder aux APIs pour :