Tempo di lettura 3min

API Kibi

Tradotto automaticamente

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.

#Attivare l'accesso all'API

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.

Screenshot: Impostazioni API in Integrazioni

#Creare un token API

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.

Screenshot: Modulo di creazione token con scope

#Conservare il token in modo sicuro

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.

Screenshot: Token dopo la creazione - visibile una sola volta

#Autorizzazioni disponibili (Scope)

I seguenti scope controllano l'accesso del token API alle diverse aree:

Scope

Descrizione

posts:read

Leggere articoli e notizie pubblicati

posts:write

Creare, aggiornare ed eliminare articoli

wiki:read

Leggere pagine wiki e documentazione

wiki:write

Creare e aggiornare pagine wiki

calendar:read

Leggere voci di calendario

calendar:write

Creare, aggiornare ed eliminare voci di calendario

groups:read

Leggere gruppi pubblici, membri, articoli e file

surveys:read

Leggere sondaggi e risultati

tasks:read

Leggere compiti (solo propri o assegnati)

tasks:write

Creare e aggiornare compiti

users:read

Leggere la directory utenti pubblica (nessun dato privato)

chat:read

Leggere conversazioni e messaggi

chat:write

Inviare messaggi (per bot e automazioni)

notifications:read

Leggere notifiche utente

notifications:write

Inviare notifiche agli utenti (inclusa push)

search

Ricerca trasversale tra entità

#Autenticazione API

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

#Endpoint disponibili

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

GET /wiki

Elencare pagine wiki

Wiki

POST /wiki

Creare una pagina wiki

Notizie

GET /posts

Elencare articoli

Compiti

GET /tasks

Elencare compiti

Calendario

GET /calendar/events

Elencare voci di calendario

Chat

POST /chat/direct

Inviare un messaggio diretto

Utenti

GET /users

Elencare la directory utenti

Ricerca

GET /search

Ricerca full-text trasversale tra entità

#Gestire i token

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

Screenshot: Panoramica token con token attivi

#Note importanti

  • 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.