Zum Inhalt springen
Kibi Connect

Kibi API

3min

Die Kibi REST API ermöglicht es externen Anwendungen, KI-Assistenten und Automatisierungen, auf Kibi Connect Daten zuzugreifen. Über die API können Inhalte gelesen und geschrieben werden -- von Wiki-Seiten über News-Beiträge bis hin zu Aufgaben und Kalendereinträgen.

API-Zugang aktivieren

Die REST API muss zuerst von einem Systemadministrator aktiviert werden. Die Einstellung befindet sich unter:

Einstellungen → Integrationen → REST API

Hier stehen folgende Optionen zur Verfügung:

  • REST API aktivieren

    Schaltet die API-Schnittstelle ein oder aus.

  • Token-Erstellung auf bestimmte Rollen einschränken

    Wenn aktiviert, können nur Benutzer mit den ausgewählten Rollen API-Token erstellen. Einzelne Benutzer können zusätzlich über den Funktionszugriff im Sicherheits-Tab ihres Profils berechtigt werden.

  • IP-Einschränkung aktivieren

    Wenn aktiviert, können nur die angegebenen IP-Adressen auf die API zugreifen. Dies ist eine zusätzliche Sicherheitsebene.

Screenshot: API-Einstellungen unter Integrationen

API-Token erstellen

Jeder Benutzer kann eigene API-Token über sein Benutzerprofil erstellen. Navigieren Sie dazu zu:

Benutzerprofil → Integrationen → Neuen Token erstellen

Beim Erstellen eines Tokens vergeben Sie:

  • Name

    Ein beschreibender Name (z.B. "KI-Agent", "ERP-Integration", "Workflow Automation").

  • Berechtigungen (Scopes)

    Wählen Sie nur die Berechtigungen aus, die die Integration tatsächlich benötigt (Least-Privilege-Prinzip).

  • Ablaufdatum (optional)

    Optional kann ein Ablaufdatum gesetzt werden, nach dem der Token automatisch ungültig wird.

Screenshot: Token-Erstellungsformular mit Scopes

Token sicher aufbewahren

Nach dem Erstellen wird der Token-Wertnur einmal angezeigt. Kopieren Sie diesen sofort und bewahren Sie ihn sicher auf (z.B. in einem Passwort-Manager). Bei Verlust muss der Token widerrufen und ein neuer erstellt werden.

Screenshot: Token nach Erstellung -- nur einmal sichtbar

Verfügbare Berechtigungen (Scopes)

Die folgenden Scopes steuern den Zugriff des API-Tokens auf verschiedene Bereiche:

Scope

Beschreibung

posts:read

Veröffentlichte Beiträge und Neuigkeiten lesen

posts:write

Beiträge erstellen, aktualisieren und löschen

wiki:read

Wiki-Seiten und Dokumentation lesen

wiki:write

Wiki-Seiten erstellen und aktualisieren

calendar:read

Kalendereinträge lesen

calendar:write

Kalendereinträge erstellen, aktualisieren und löschen

groups:read

Öffentliche Gruppen, Mitglieder, Beiträge und Dateien lesen

surveys:read

Umfragen und Ergebnisse lesen

tasks:read

Aufgaben lesen (nur eigene oder zugewiesene)

tasks:write

Aufgaben erstellen und aktualisieren

users:read

Öffentliches Benutzerverzeichnis lesen (keine privaten Daten)

chat:read

Konversationen und Nachrichten lesen

chat:write

Nachrichten senden (für Bots und Automatisierungen)

notifications:read

Benutzer-Benachrichtigungen lesen

notifications:write

Benachrichtigungen an Benutzer senden (inkl. Push)

search

Entitätsübergreifende Suche

API-Authentifizierung

Alle API-Anfragen müssen den Token als Bearer-Token im Authorization-Header mitschicken:

curl -H "Authorization: Bearer kbc_IhrTokenHier" \
     https://ihre-firma.kibi.de/api/v1/wiki

Die API-Basis-URL lautet:https://ihre-firma.kibi.de/api/v1

Verfügbare Endpunkte

Die vollständige API-Dokumentation mit allen Endpunkten und Parametern ist direkt in Kibi Connect verfügbar unter:

  • Interaktive Dokumentation: Benutzerprofil → Integrationen → API-Dokumentation

  • OpenAPI-Spezifikation (JSON): Benutzerprofil → Integrationen → OpenAPI JSON

Die wichtigsten Endpunkte im Überblick:

Bereich

Endpunkt

Beschreibung

Wiki

GET /wiki

Wiki-Seiten auflisten

Wiki

POST /wiki

Wiki-Seite erstellen

News

GET /posts

Beiträge auflisten

Aufgaben

GET /tasks

Aufgaben auflisten

Kalender

GET /calendar/events

Kalendereinträge auflisten

Chat

POST /chat/direct

Direktnachricht senden

Benutzer

GET /users

Benutzerverzeichnis auflisten

Suche

GET /search

Entitätsübergreifende Volltextsuche

Token verwalten

Alle erstellten Token werden in der Übersicht unter Benutzerprofil → Integrationen angezeigt. Hier sehen Sie:

  • Den Token-Namen

  • Die zugewiesenen Berechtigungen

  • Wann der Token zuletzt verwendet wurde

  • Die Möglichkeit, einen Token zu widerrufen

Screenshot: Token-Übersicht mit aktiven Tokens

Wichtige Hinweise

  • Datenzugriff: API-Token haben nur Zugriff auf die Daten, auf die der jeweilige Benutzer auch Zugriff hat. Die Berechtigungen des Benutzers gelten weiterhin.

  • Sicherheit: Teilen Sie API-Token niemals öffentlich. Speichern Sie Token in Umgebungsvariablen oder einem Secret-Manager, nicht im Quellcode.

  • Least Privilege: Vergeben Sie nur die minimal notwendigen Berechtigungen. Ein Token für eine Wiki-Integration braucht keinen Zugriff auf den Chat.

  • Ablaufdatum: Setzen Sie bei temporären Integrationen ein Ablaufdatum, um die Sicherheit zu erhöhen.

  • Widerruf: Widerrufen Sie nicht mehr benötigte Token umgehend über die Token-Übersicht.