Kibi API

Kibi REST API omogoča zunanjim aplikacijam, umetni pomočnikom in avtomatizacijam dostop do podatkov Kibi Connect. Preko API-ja lahko berete in pišete vsebine – od wiki-strani, novičarskih prispevkov do nalog in koledarskih vnosov.

#Omogočitev dostopa do API-ja

REST API morate najprej omogočiti sistemski administrator. Nastavitev najdete pod:

Nastavitve → Integracije → REST API

Na voljo so naslednje možnosti:

Omogoči REST API

Vklopi ali izklopi API vmesnik.
Omejitev ustvarjanja žetonov na določene vloge

Če je omogočeno, lahko le uporabniki z izbranimi vlogami ustvarjajo API žetone. Posamezni uporabniki lahko dobijo dodatna dovoljenja prek dostopa do funkcij v zavihku Varnost svojega profila.
Omogoči omejitev IP-naslovov

Če je omogočeno, lahko le navedeni IP-naslovi dostopajo do API-ja. To je dodatna ravnen varnosti.

Zaslonska slika: Nastavitve API-ja pod Integracije

#Ustvarjanje API žetona

Vsak uporabnik lahko v svojem uporabniškem profilu ustvari lastne API žetone. Za to odprite:

Uporabniški profil → Integracije → Ustvari nov žeton

Pri ustvarjanju žetona morate nastaviti:

Ime

Opisi ime (npr. "Umetni agent", "ERP integracija", "Avtomatizacija delovnih tokov").
Dovoljenja (Scopes)

Izberite samo tista dovoljenja, ki jih integracija res potrebuje (princip najmanjših privilegijev).
Datum poteka (neobvezno)

Neobvezno lahko nastavite datum poteka, po katerem bo žeton samodejno veljal.

Zaslonska slika: Obrazec za ustvarjanje žetona z dovoljenji

#Varno shranjevanje žetona

Po ustvarjanju se vrednost žetona pokaže le enkrat. Takoj ga kopirajte in varno shranite (npr. v upravljalniku gesel). Če ga izgubite, morate žeton preklicati in ustvariti novega.

Zaslonska slika: Žeton po ustvarjanju – vidno le enkrat

#Razpoložljiva dovoljenja (Scopes)

Naslednja dovoljenja nadzorujejo dostop API žetona do različnih področij:

Scope	Opis
`posts:read`	Branje objavljenih prispevkov in novic
`posts:write`	Ustvarjanje, posodabljanje in brisanje prispevkov
`wiki:read`	Branje wiki-strani in dokumentacije
`wiki:write`	Ustvarjanje in posodabljanje wiki-strani
`calendar:read`	Branje koledarskih vnosov
`calendar:write`	Ustvarjanje, posodabljanje in brisanje koledarskih vnosov
`groups:read`	Branje javnih skupin, članov, prispevkov in datotek
`surveys:read`	Branje anket in rezultatov
`tasks:read`	Branje nalog (samo lastnih ali dodeljenih)
`tasks:write`	Ustvarjanje in posodabljanje nalog
`users:read`	Branje javnega imenišnika uporabnikov (brez zasebnih podatkov)
`chat:read`	Branje pogovorov in sporočil
`chat:write`	Pošiljanje sporočil (za bote in avtomatizacije)
`notifications:read`	Branje uporabniških obvestil
`notifications:write`	Pošiljanje obvestil uporabnikom (vključno z obvestili prek push)
`search`	Iskanje čez entitete

#Overitev API-ja

Vse zahtevke API-ja morajo vsebovati žeton kot Bearer žeton v glavi Authorization:

curl -H "Authorization: Bearer kbc_VašTokenTukaj" \
     https://vaše-podjetje.kibi.de/api/v1/wiki

Osnovni URL API-ja je: https://vaše-podjetje.kibi.de/api/v1

#Razpoložljive končne točke

Popolna dokumentacija API-ja z vsemi končnimi točkami in parametri je neposredno dostopna v Kibi Connect pod:

Interaktivna dokumentacija: Uporabniški profil → Integracije → Dokumentacija API-ja
OpenAPI specifikacija (JSON): Uporabniški profil → Integracije → OpenAPI JSON

Pregled najpomembnejših končnih točk:

Področje	Končna točka	Opis
Wiki	`GET /wiki`	Seznam wiki-strani
Wiki	`POST /wiki`	Ustvarjanje wiki-strani
Novice	`GET /posts`	Seznam prispevkov
Naloge	`GET /tasks`	Seznam nalog
Koledar	`GET /calendar/events`	Seznam koledarskih vnosov
Klepet	`POST /chat/direct`	Pošiljanje neposrednih sporočil
Uporabniki	`GET /users`	Seznam imenišnika uporabnikov
Iskanje	`GET /search`	Polno besedilno iskanje čez entitete

#Upravljanje žetonov

Vsi ustvarjeni žetoni so prikazani v pregledni pod Uporabniški profil → Integracije. Tu vidite:

Ime žetona
Dodeljena dovoljenja
Kdaj je bil žeton nazadnje uporabljen
Možnost preklica žetona

Zaslonska slika: Pregled žetonov z aktivnimi žetoni

#Pomembna opozorila

Dostop do podatkov: API žetoni imajo dostop le do tistih podatkov, do katerih ima dostop ustrezni uporabnik. Veljajo dovoljenja uporabnika.
Varnost: Nikoli ne delite API žetonov javno. Shranjujte žetone v okolijskih spremenljivkah ali v upravljalniku skrivnosti, ne v izvorni kodi.
Princip najmanjših privilegijev: Dodelite le minimalno potrebna dovoljenja. Žeton za wiki integracijo ne potrebuje dostopa do klepeta.
Datum poteka: Za začasne integracije nastavite datum poteka, da povečate varnost.
Preklic: Neuporabljene žetone takoj preklicite prek pregleda žetonov.