L'API REST di Kibi consente alle applicazioni esterne, agli assistenti AI e alle automazioni di accedere ai dati di Kibi Connect. Tramite l'API è possibile leggere e scrivere contenuti, dalle pagine wiki agli articoli di notizie, fino a compiti e voci di calendario.
L'API REST deve essere prima attivata da un amministratore di sistema. L'impostazione si trova in:
Impostazioni → Integrazioni → API REST
Qui sono disponibili le seguenti opzioni:
Attivare API REST
Attiva o disattiva l'interfaccia API.
Limitare la creazione dei token a determinati ruoli
Se attivata, solo gli utenti con i ruoli selezionati possono creare token API. Singoli utenti possono essere autorizzati ulteriormente tramite l'accesso alle funzioni nella scheda Sicurezza del loro profilo.
Attivare la limitazione IP
Se attivata, solo gli indirizzi IP specificati possono accedere all'API. Questo rappresenta un ulteriore livello di sicurezza.
Ogni utente può creare i propri token API tramite il proprio profilo utente. Per fare ciò, navigare in:
Profilo utente → Integrazioni → Crea nuovo token
Durante la creazione di un token, è necessario assegnare:
Nome
Un nome descrittivo (ad esempio "Agente AI", "Integrazione ERP", "Automazione workflow").
Autorizzazioni (Scope)
Selezionare solo le autorizzazioni di cui l'integrazione ha effettivamente bisogno (principio del minimo privilegio).
Data di scadenza (opzionale)
Facoltativamente, è possibile impostare una data di scadenza dopo la quale il token diventa automaticamente non valido.
Dopo la creazione, il valore del token viene mostrato una sola volta. Copiatelo immediatamente e conservatelo in modo sicuro (ad esempio in un gestore di password). In caso di smarrimento, il token deve essere revocato e ne deve essere creato uno nuovo.
I seguenti scope controllano l'accesso del token API alle diverse aree:
Scope |
Descrizione |
|---|---|
|
Leggere articoli e notizie pubblicati |
|
Creare, aggiornare ed eliminare articoli |
|
Leggere pagine wiki e documentazione |
|
Creare e aggiornare pagine wiki |
|
Leggere voci di calendario |
|
Creare, aggiornare ed eliminare voci di calendario |
|
Leggere gruppi pubblici, membri, articoli e file |
|
Leggere sondaggi e risultati |
|
Leggere compiti (solo propri o assegnati) |
|
Creare e aggiornare compiti |
|
Leggere la directory utenti pubblica (nessun dato privato) |
|
Leggere conversazioni e messaggi |
|
Inviare messaggi (per bot e automazioni) |
|
Leggere notifiche utente |
|
Inviare notifiche agli utenti (inclusa push) |
|
Ricerca trasversale tra entità |
Tutte le richieste API devono includere il token come Bearer Token nell'intestazione Authorization:
curl -H "Authorization: Bearer kbc_IhrTokenHier" \
https://la-tua-azienda.kibi.de/api/v1/wiki
L'URL base dell'API è: https://la-tua-azienda.kibi.de/api/v1
La documentazione completa dell'API con tutti gli endpoint e i parametri è disponibile direttamente in Kibi Connect in:
Documentazione interattiva: Profilo utente → Integrazioni → Documentazione API
Specifica OpenAPI (JSON): Profilo utente → Integrazioni → OpenAPI JSON
Panoramica dei principali endpoint:
Area |
Endpoint |
Descrizione |
|---|---|---|
Wiki |
|
Elencare pagine wiki |
Wiki |
|
Creare una pagina wiki |
Notizie |
|
Elencare articoli |
Compiti |
|
Elencare compiti |
Calendario |
|
Elencare voci di calendario |
Chat |
|
Inviare un messaggio diretto |
Utenti |
|
Elencare la directory utenti |
Ricerca |
|
Ricerca full-text trasversale tra entità |
Tutti i token creati vengono visualizzati nella panoramica in Profilo utente → Integrazioni. Qui è possibile vedere:
Il nome del token
Le autorizzazioni assegnate
Quando il token è stato utilizzato l'ultima volta
La possibilità di revocare un token
Accesso ai dati: I token API hanno accesso solo ai dati a cui l'utente corrispondente ha accesso. Le autorizzazioni dell'utente rimangono valide.
Sicurezza: Non condividere mai i token API pubblicamente. Conservare i token in variabili d'ambiente o in un gestore di segreti, non nel codice sorgente.
Minimo privilegio: Assegnare solo le autorizzazioni strettamente necessarie. Un token per un'integrazione wiki non ha bisogno di accedere alla chat.
Data di scadenza: Per le integrazioni temporanee, impostare una data di scadenza per aumentare la sicurezza.
Revoca: Revocare immediatamente i token non più necessari tramite la panoramica dei token.