API publique Kabeen
Une API REST pour lire et gérer l'inventaire du patrimoine IT de votre espace de travail depuis vos propres outils et scripts
L'API publique Kabeen est une API REST destinée aux intégrations qui ont besoin de lire ou de gérer l'inventaire du patrimoine IT d'un espace de travail — applications, serveurs, réseaux, routeurs, postes de travail, objets de données, contrats, structure organisationnelle, personnes, annonces et historique d'audit. Elle est conçue pour les outils externes : synchronisations CMDB, tableaux de bord sur mesure, passerelles ITSM, pipelines de reporting et scripts d'automatisation internes qui ont besoin d'un accès programmatique aux mêmes données qu'un administrateur voit dans le produit Kabeen.
Il s'agit de la version 1.0.0, la première version publique de l'API.
URL de base et versionnement
https://app.kabeen.io/public/v1Remplacez app.kabeen.io par votre propre hôte si vous hébergez Kabeen vous-même. Le segment de chemin v1 correspond à la version de l'API : les changements incompatibles seront publiés sous un nouveau préfixe de version plutôt que de modifier v1 en place.
Tous les corps de requête et de réponse sont en JSON. Tous les endpoints lisent et écrivent sur un seul espace de travail — celui auquel la clé d'API est liée. Il n'existe aucun moyen d'adresser un autre espace de travail avec la même clé.
Authentification
Chaque requête est authentifiée avec une clé d'API liée à l'espace de travail, transmise soit via Authorization: Bearer kbn_live_..., soit via X-Api-Key: kbn_live_.... L'espace de travail est lié à la clé elle-même — il n'est jamais passé dans le chemin ni dans le corps de la requête.
Les clés portent un ensemble de scopes de permission (par exemple applications:read, contracts:add), et chaque endpoint documente le scope exact qu'il requiert. Appelez GET /public/v1/me pour introspecter une clé : la réponse contient l'espace de travail auquel la clé appartient, les métadonnées de la clé et les scopes qu'elle accorde.
Consultez Authentification pour le guide complet, y compris la création, la rotation et la révocation des clés.
Domaines de ressources
L'API est organisée en domaines de ressources, pour un total d'environ 200 opérations :
| Domaine | Description | Scope(s) principal(aux) |
|---|---|---|
| Introspection | Décrire la clé d'API présentée : espace de travail, métadonnées, scopes accordés. | toute clé valide |
| Applications | Inventaire des applications, fiche détaillée et sous-ressources (usages, flux, technologies, contrats, commentaires, responsables, tags, équipes, cycle de vie, documents, champs personnalisés, métriques d'expérience, capacités fonctionnelles). | applications:read / :add / :edit / :delete / :comment |
| Serveurs | Serveurs d'infrastructure déclarés manuellement ou remontés par les agents, avec responsables, tags, interfaces, métriques et applications liées. | infrastructure:read / :add / :edit / :delete |
| Réseaux | Réseaux et leurs routeurs connectés. | infrastructure:read / :add / :edit / :delete |
| Routeurs | Équipements réseau — routeur, pare-feu, commutateur, point d'accès. | infrastructure:read / :add / :edit / :delete |
| Postes de travail & logiciels | Postes de travail remontés par les agents, programmes installés, inventaire logiciel et statut de déploiement des agents. | infrastructure:read, agents:read |
| Données | Objets de données (actifs informationnels) et leurs liens avec les applications. | data:read / :add / :edit / :delete |
| Catalogue | Recherche dans le catalogue applicatif global et applications auto-découvertes. | applications:read |
| Contrats | Contrats des applications, aplatis à l'échelle de l'espace de travail. | contracts:read / :add / :edit / :delete |
| Taxonomie | Catégories et tags d'applications. | categories:*, tags:* |
| Organisation | Arborescence de l'organisation et équipes (unités métier). | organisation:read / :add / :edit / :delete |
| Personnes | Utilisateurs finaux suivis (avec métriques d'expérience) et membres de l'espace de travail. | users:read, members:read |
| Espace de travail | L'espace de travail (tenant) auquel la clé est liée. | tenant:read / :edit |
| Annonces | Annonces de l'espace de travail. | announces:read / :add / :edit / :delete |
| Journal d'audit | Événements d'audit de l'espace de travail, paginés par curseur. | audit_log:read |
| Tableaux de bord, insights & diagrammes | Tableaux de bord agrégés (finance, usages, opérations, architecture, technologie, postes de travail), insights de santé et diagrammes d'architecture. | *_dashboard:read, *_diagram:read, applications:read |
La liste complète des endpoints, avec leurs entrées et sorties, se trouve dans la Référence des endpoints.
Conventions
- JSON partout — chaque corps de requête et de réponse est en JSON (
application/json). - UUID et dates sous forme de chaînes — les identifiants de ressources sont des chaînes UUID ; les dates et horodatages sont des chaînes ISO-8601.
- Pagination par offset — les endpoints de liste acceptent
limit(1–200, 50 par défaut) etoffset(0 par défaut) et renvoient une enveloppe{ "data": [...], "pagination": { "limit", "offset", "total" } }. Le journal d'audit est la seule exception : il utilise une pagination par curseur. Voir Pagination et erreurs. - Erreurs uniformes — chaque corps de réponse 4xx/5xx a la même forme :
{ "code", "message", "status" }. - Audité — chaque appel à l'API publique est inscrit dans le journal d'audit de l'espace de travail, avec la clé d'API comme acteur.
- Pas de webhooks — l'API fonctionne uniquement par interrogation (polling) dans cette version ; il n'existe aucun mécanisme d'événements ou de webhooks. Le journal d'audit est ce qui se rapproche le plus d'un flux de changements — voir Pagination et erreurs pour les recommandations de polling.
API publique ou serveur MCP ?
Les deux surfaces exposent la cartographie de l'espace de travail. Choisissez selon le consommateur :
- L'API publique (cette section) est destinée aux intégrations programmatiques déterministes — scripts, synchronisations, pipelines. Elle s'authentifie avec une clé d'API agissant comme identité de service.
- Le serveur MCP est destiné aux assistants et agents IA. Il s'authentifie via OAuth en tant que membre humain et hérite des permissions de ce membre.
La suite
- Démarrage rapide — effectuez votre premier appel authentifié en cinq minutes.
- Authentification — clés d'API, scopes et
/me. - Référence des endpoints — chaque endpoint avec ses entrées et sorties.