Kibi API
3min
De Kibi REST API maakt het mogelijk voor externe applicaties, AI-assistenten en automatisering om toegang te krijgen tot Kibi Connect-gegevens. Via de API kunnen inhoud worden gelezen en geschreven – van wiki-pagina's en nieuwsberichten tot taken en kalenderitems.
API-toegang activeren
De REST API moet eerst worden geactiveerd door een systeembeheerder. De instelling bevindt zich onder:
Instellingen → Integraties → REST API
Hier zijn de volgende opties beschikbaar:
REST API activeren
Schakelt de API-interface in of uit.
Token-creatie beperken tot specifieke rollen
Als geactiveerd, kunnen alleen gebruikers met de geselecteerde rollen API-tokens aanmaken. Individuele gebruikers kunnen aanvullend worden geautoriseerd via de functietoegang in het beveiligingstabblad van hun profiel.
IP-beperking activeren
Als geactiveerd, kunnen alleen de opgegeven IP-adressen toegang krijgen tot de API. Dit is een extra beveiligingslaag.
API-token aanmaken
Elke gebruiker kan eigen API-tokens aanmaken via zijn gebruikersprofiel. Navigeer hiervoor naar:
Gebruikersprofiel → Integraties → Nieuwe token aanmaken
Bij het aanmaken van een token geeft u op:
Naam
Een beschrijvende naam (bijv. "KI-Agent", "ERP-Integratie", "Workflow Automatisering").
Machtigingen (Scopes)
Selecteer alleen de machtigingen die de integratie daadwerkelijk nodig heeft (minimale-rechten-principe).
Vervaldatum (optioneel)
Optioneel kan een vervaldatum worden ingesteld, waarna de token automatisch ongeldig wordt.
Token veilig bewaren
Na het aanmaken wordt de token-waarde maar één keer getoond. Kopieer deze onmiddellijk en bewaar deze veilig (bijv. in een wachtwoordmanager). Bij verlies moet de token worden ingetrokken en een nieuwe worden aangemaakt.
Beschikbare machtigingen (Scopes)
De volgende Scopes regelen de toegang van de API-token tot verschillende gebieden:
Scope |
Beschrijving |
|---|---|
|
Gepubliceerde berichten en nieuws lezen |
|
Berichten aanmaken, bijwerken en verwijderen |
|
Wiki-pagina's en documentatie lezen |
|
Wiki-pagina's aanmaken en bijwerken |
|
Kalenderitems lezen |
|
Kalenderitems aanmaken, bijwerken en verwijderen |
|
Openbare groepen, leden, berichten en bestanden lezen |
|
Enquêtes en resultaten lezen |
|
Taken lezen (alleen eigen of toegewezen) |
|
Taken aanmaken en bijwerken |
|
Openbare gebruikersdirectory lezen (geen privégegevens) |
|
Gesprekken en berichten lezen |
|
Berichten verzenden (voor bots en automatisering) |
|
Gebruikersmeldingen lezen |
|
Meldingen naar gebruikers verzenden (inclusief push) |
|
Door entiteiten heen zoeken |
API-authenticatie
Alle API-verzoeken moeten de token als Bearer-token in de Authorization-header meezenden:
curl -H "Authorization: Bearer kbc_UwTokenHier" \
https://uw-bedrijf.kibi.de/api/v1/wiki
De basis-URL van de API is: https://uw-bedrijf.kibi.de/api/v1
Beschikbare endpoints
De volledige API-documentatie met alle endpoints en parameters is direct beschikbaar in Kibi Connect onder:
Interactieve documentatie: Gebruikersprofiel → Integraties → API-documentatie
OpenAPI-specificatie (JSON): Gebruikersprofiel → Integraties → OpenAPI JSON
De belangrijkste endpoints in overzicht:
Gebied |
Endpoint |
Beschrijving |
|---|---|---|
Wiki |
|
Wiki-pagina's weergeven |
Wiki |
|
Wiki-pagina aanmaken |
Nieuws |
|
Berichten weergeven |
Taken |
|
Taken weergeven |
Kalender |
|
Kalenderitems weergeven |
Chat |
|
Direct bericht verzenden |
Gebruikers |
|
Gebruikersdirectory weergeven |
Zoeken |
|
Volledige tekst zoeken over entiteiten heen |
Token beheren
Alle aangemaakte tokens worden weergegeven in het overzicht onder Gebruikersprofiel → Integraties. Hier ziet u:
De tokennaam
De toegewezen machtigingen
Wanneer de token voor het laatst is gebruikt
De mogelijkheid om een token in te trekken
Belangrijke opmerkingen
Datatoegang: API-tokens hebben alleen toegang tot de gegevens waarvoor de betreffende gebruiker ook toegang heeft. De machtigingen van de gebruiker blijven van kracht.
Beveiliging: Deel API-tokens nooit openbaar. Sla tokens op in omgevingsvariabelen of een secret manager, niet in de broncode.
Minimale rechten: Geef alleen de strikt noodzakelijke machtigingen. Een token voor een wiki-integratie heeft geen toegang tot de chat nodig.
Vervaldatum: Stel bij tijdelijke integraties een vervaldatum in om de beveiliging te verhogen.
Intrekking: Trek niet langer nodige tokens onmiddellijk in via het token-overzicht.