Reading time 3min

Kibi API

Automatically translated

De Kibi REST API makt et externen Anwendungen, KI-Assistenten un Automatisierungen möglik, op Kibi Connect Daten tozugreifen. Über de API kunnt Inhalte lesen un schreiben warrn – von Wiki-Seiten über News-Beiträge bis hin to Aufgaben un Kalendereinträgen.

#API-Zugang aktivieren

De REST API mut erstmal von'n Systemadministrator aktiviert warrn. De Einstellung finnt sick unter:

Einstellungen → Integrationen → REST API

Hier steiht folgende Optionen to Verfügung:

  • REST API aktivieren

    Schallt de API-Schnittstelle an oder ut.

  • Token-Erstellung op bestimmte Rollen einschränken

    Wenn aktiviert, kunnt nur Benutzer mit de ausgewählten Rollen API-Token machen. Einzelne Benutzer kunnt zusätzlich über'n Funktionszugriff in'n Sicherheits-Tab von ihr Profil berechtigt warrn.

  • IP-Einschränkung aktivieren

    Wenn aktiviert, kunnt nur de angegebnen IP-Adressen op de API togrepen. Dat is 'ne zusätzliche Sicherheitsebene.

Screenshot: API-Einstellungen unter Integrationen

#API-Token erstellen

Jeder Benutzer kann eigene API-Token über sein Benutzerprofil machen. Navigieren Se to:

Benutzerprofil → Integrationen → Neuen Token erstellen

Beim Machen von'n Token geben Se an:

  • Name

    'n beschreibenden Namen (z. B. „KI-Agent“, „ERP-Integration“, „Workflow Automation“).

  • Berechtigungen (Scopes)

    Wählen Se nur de Berechtigungen ut, de de Integration tatsächlich braucht (Least-Privilege-Prinzip).

  • Ablaufdatum (optional)

    Optional kann 'n Ablaufdatum sett warrn, nach dem de Token automatisch ungültig warrt.

Screenshot: Token-Erstellungsformular mit Scopes

#Token sicher aufbewahren

Nach dem Machen warrt de Token-Wert nur einmal anzeigt. Kopieren Se den direkt un bewahren Se ihn sicher op (z. B. in'n Passwort-Manager). Bei Verlust mut de Token widerrufen un 'n neuen gemacht warrn.

Screenshot: Token nach Erstellung -- nur einmal sichtbar

#Verfügbare Berechtigungen (Scopes)

De folgenden Scopes steuern den Zugriff von'n API-Token op verschiedene Bereiche:

Scope

Beschreibung

posts:read

Veröffentlichte Beiträge un Neuigkeiten lesen

posts:write

Beiträge machen, aktualisieren un löschen

wiki:read

Wiki-Seiten un Dokumentation lesen

wiki:write

Wiki-Seiten machen un aktualisieren

calendar:read

Kalendereinträge lesen

calendar:write

Kalendereinträge machen, aktualisieren un löschen

groups:read

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

surveys:read

Umfragen un Ergebnisse lesen

tasks:read

Aufgaben lesen (nur eigene oder zugewiesene)

tasks:write

Aufgaben machen un aktualisieren

users:read

Öffentliches Benutzerverzeichnis lesen (keine privaten Daten)

chat:read

Konversationen un Nachrichten lesen

chat:write

Nachrichten senden (für Bots un 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üss'n den Token as Bearer-Token in'n Authorization-Header mitschicken:

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

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

#Verfügbare Endpunkte

De vollständige API-Dokumentation mit allen Endpunkten un Parametern is direkt in Kibi Connect to finden unter:

  • Interaktive Dokumentation: Benutzerprofil → Integrationen → API-Dokumentation

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

De wichtigsten Endpunkte im Überblick:

Bereich

Endpunkt

Beschreibung

Wiki

GET /wiki

Wiki-Seiten auflisten

Wiki

POST /wiki

Wiki-Seite machen

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 gemachten Token warrt in de Übersicht unter Benutzerprofil → Integrationen anzeigt. Hier sehen Se:

  • Den Token-Namen

  • De zugewiesenen Berechtigungen

  • Wann de Token zuletzt verwendet warrt

  • De Möglichkeit, 'n Token to widerrufen

Screenshot: Token-Übersicht mit aktiven Tokens

#Wichtige Hinweise

  • Datenzugriff: API-Token hebbt nur Zugriff op de Daten, op de de jeweilige Benutzer ok Zugriff hett. De Berechtigungen von'n Benutzer gelten weiterhin.

  • Sicherheit: Teilen Se API-Token niemals öffentlich. Speichern Se Token in Umgebungsvariablen oder'n Secret-Manager, nich in'n Quellcode.

  • Least Privilege: Geben Se nur de minimal notwendigen Berechtigungen. 'n Token för 'ne Wiki-Integration braucht keen Zugriff op den Chat.

  • Ablaufdatum: Setten Se bei temporären Integrationen 'n Ablaufdatum, um de Sicherheit to erhöhen.

  • Widerruf: Widerrufen Se nich mehr benötigte Token umgehend über de Token-Übersicht.