L'API REST Kibi permet aux applications externes, aux assistants IA et aux automatisations d'accéder aux données de Kibi Connect. Via l'API, il est possible de lire et d'écrire du contenu, des pages wiki aux articles d'actualité, en passant par les tâches et les entrées de calendrier.
L'API REST doit d'abord être activée par un administrateur système. Le paramètre se trouve sous :
Paramètres → Intégrations → API REST
Les options suivantes sont disponibles :
Activer l'API REST
Active ou désactive l'interface API.
Restreindre la création de jetons à certains rôles
Si activé, seuls les utilisateurs disposant des rôles sélectionnés peuvent créer des jetons API. Des utilisateurs individuels peuvent en outre être autorisés via l'accès aux fonctions dans l'onglet Sécurité de leur profil.
Activer la restriction par IP
Si activé, seules les adresses IP spécifiées peuvent accéder à l'API. Cela constitue une couche de sécurité supplémentaire.
Chaque utilisateur peut créer ses propres jetons API via son profil utilisateur. Pour ce faire, accédez à :
Profil utilisateur → Intégrations → Créer un nouveau jeton
Lors de la création d'un jeton, vous définissez :
Nom
Un nom descriptif (par ex. « Agent IA », « Intégration ERP », « Automatisation de workflow »).
Autorisations (Scopes)
Sélectionnez uniquement les autorisations dont l'intégration a réellement besoin (principe du moindre privilège).
Date d'expiration (facultatif)
Une date d'expiration peut éventuellement être définie, après laquelle le jeton deviendra automatiquement invalide.
Après la création, la valeur du jeton n'est affichée qu'une seule fois. Copiez-la immédiatement et conservez-la en lieu sûr (par ex. dans un gestionnaire de mots de passe). En cas de perte, le jeton doit être révoqué et un nouveau doit être créé.
Les Scopes suivants contrôlent l'accès du jeton API aux différentes zones :
Scope |
Description |
|---|---|
|
Lire les articles et actualités publiés |
|
Créer, mettre à jour et supprimer des articles |
|
Lire les pages wiki et la documentation |
|
Créer et mettre à jour des pages wiki |
|
Lire les entrées de calendrier |
|
Créer, mettre à jour et supprimer des entrées de calendrier |
|
Lire les groupes publics, les membres, les articles et les fichiers |
|
Lire les sondages et les résultats |
|
Lire les tâches (uniquement les siennes ou celles qui sont assignées) |
|
Créer et mettre à jour des tâches |
|
Lire l'annuaire public des utilisateurs (pas de données privées) |
|
Lire les conversations et les messages |
|
Envoyer des messages (pour les bots et automatisations) |
|
Lire les notifications utilisateur |
|
Envoyer des notifications aux utilisateurs (y compris push) |
|
Recherche trans-entités |
Toutes les requêtes API doivent inclure le jeton en tant que Bearer Token dans l'en-tête Authorization :
curl -H "Authorization: Bearer kbc_VotreJetonIci" \
https://votre-entreprise.kibi.de/api/v1/wiki
L'URL de base de l'API est : https://votre-entreprise.kibi.de/api/v1
La documentation complète de l'API avec tous les points de terminaison et paramètres est disponible directement dans Kibi Connect sous :
Documentation interactive : Profil utilisateur → Intégrations → Documentation de l'API
Spécification OpenAPI (JSON) : Profil utilisateur → Intégrations → OpenAPI JSON
Les principaux points de terminaison en un coup d'œil :
Domaine |
Point de terminaison |
Description |
|---|---|---|
Wiki |
|
Lister les pages wiki |
Wiki |
|
Créer une page wiki |
Actualités |
|
Lister les articles |
Tâches |
|
Lister les tâches |
Calendrier |
|
Lister les entrées de calendrier |
Chat |
|
Envoyer un message direct |
Utilisateurs |
|
Lister l'annuaire des utilisateurs |
Recherche |
|
Recherche en texte intégral trans-entités |
Tous les jetons créés sont affichés dans l'aperçu sous Profil utilisateur → Intégrations. Vous y voyez :
Le nom du jeton
Les autorisations attribuées
Quand le jeton a été utilisé pour la dernière fois
La possibilité de révoquer un jeton
Accès aux données : Les jetons API n'ont accès qu'aux données auxquelles l'utilisateur concerné a également accès. Les autorisations de l'utilisateur restent applicables.
Sécurité : Ne partagez jamais les jetons API publiquement. Stockez les jetons dans des variables d'environnement ou un gestionnaire de secrets, et non dans le code source.
Moindre privilège : N'attribuez que les autorisations strictement nécessaires. Un jeton pour une intégration wiki n'a pas besoin d'accéder au chat.
Date d'expiration : Pour les intégrations temporaires, définissez une date d'expiration pour renforcer la sécurité.
Révocation : Révoquez immédiatement les jetons qui ne sont plus nécessaires via l'aperçu des jetons.