Kibi API

A Kibi REST API lehetővé teszi külső alkalmazások, MI-asszisztensek és automatizmusok számára a Kibi Connect adatokhoz való hozzáférést. Az API-n keresztül tartalmakat lehet olvasni és írni – a wiki-oldalaktól a hírekig, a feladatokon és naptári bejegyzéseken át.

#API-hozzáférés engedélyezése

A REST API-t először egy rendszergazdának kell engedélyeznie. A beállítás a következő helyen található:

Beállítások → Integrációk → REST API

Itt a következő opciók érhetők el:

REST API engedélyezése

Az API-felület bekapcsolása vagy kikapcsolása.
Token-létrehozás korlátozása bizonyos szerepkörökre

Ha engedélyezve van, csak a kiválasztott szerepkörökkel rendelkező felhasználók hozhatnak létre API-tokeneket. Egyes felhasználók továbbá a biztonsági fülön, a profiljuk funkcióhozzáférésén keresztül kaphatnak jogot.
IP-korlátozás engedélyezése

Ha engedélyezve van, csak a megadott IP-címek férhetnek hozzá az API-hoz. Ez egy további biztonsági réteg.

Képernyőfotó: API-beállítások az Integrációk alatt

#API-token létrehozása

Minden felhasználó saját API-tokeneket hozhat létre a felhasználói profilján keresztül. Ehhez navigáljon a következőre:

Felhasználói profil → Integrációk → Új token létrehozása

Egy token létrehozásakor a következőket kell megadni:

Név

Leíró név (pl. „MI-ügynök”, „ERP-integráció”, „Munkafolyamat-automatizálás”).
Jogosultságok (Scopes)

Válassza ki csak azokat a jogosultságokat, amelyre az integrációnak valóban szüksége van (minimális jogosultság elve).
Lejárati dátum (opcionális)

Opcionálisan beállíthat egy lejárati dátumot, amely után a token automatikusan érvényét veszti.

Képernyőfotó: Token-létrehozó űrlap a Scopes-szal

#Token biztonságos tárolása

A létrehozás után a token értékét csak egyszer mutatja be. Másolja ki azonnal, és tárolja biztonságosan (pl. egy jelszókezelőben). Veszteség esetén a tokent vissza kell vonni, és újat kell létrehozni.

Képernyőfotó: Token a létrehozás után – csak egyszer látható

#Rendelkezésre álló jogosultságok (Scopes)

A következő Scopes vezérlik az API-token különböző területekhez való hozzáférését:

Scope	Leírás
`posts:read`	Közzétett bejegyzések és hírek olvasása
`posts:write`	Bejegyzések létrehozása, frissítése és törlése
`wiki:read`	Wiki-oldalak és dokumentáció olvasása
`wiki:write`	Wiki-oldalak létrehozása és frissítése
`calendar:read`	Naptári bejegyzések olvasása
`calendar:write`	Naptári bejegyzések létrehozása, frissítése és törlése
`groups:read`	Nyilvános csoportok, tagok, bejegyzések és fájlok olvasása
`surveys:read`	Felmérések és eredmények olvasása
`tasks:read`	Feladatok olvasása (csak saját vagy hozzárendelt)
`tasks:write`	Feladatok létrehozása és frissítése
`users:read`	Nyilvános felhasználói könyvtár olvasása (nincsenek benne magánadatok)
`chat:read`	Beszélgetések és üzenetek olvasása
`chat:write`	Üzenetek küldése (botok és automatizmusok számára)
`notifications:read`	Felhasználói értesítések olvasása
`notifications:write`	Értesítések küldése felhasználóknak (push-értesítések is)
`search`	Entitásfüggetlen keresés

#API-hitelesítés

Minden API-kérésnek a tokent Bearer-tokenként kell tartalmaznia az Authorization-fejlécben:

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

Az API-alap-URL a következő: https://ceged.kibi.de/api/v1

#Rendelkezésre álló végpontok

A teljes API-dokumentáció minden végponttal és paraméterrel közvetlenül a Kibi Connect-ben érhető el a következő helyen:

Interaktív dokumentáció: Felhasználói profil → Integrációk → API-dokumentáció
OpenAPI-specifikáció (JSON): Felhasználói profil → Integrációk → OpenAPI JSON

A legfontosabb végpontok áttekintése:

Terület	Végpont	Leírás
Wiki	`GET /wiki`	Wiki-oldalak listázása
Wiki	`POST /wiki`	Wiki-oldal létrehozása
Hírek	`GET /posts`	Bejegyzések listázása
Feladatok	`GET /tasks`	Feladatok listázása
Naptár	`GET /calendar/events`	Naptári bejegyzések listázása
Cset	`POST /chat/direct`	Közvetlen üzenet küldése
Felhasználók	`GET /users`	Felhasználói könyvtár listázása
Keresés	`GET /search`	Entitásfüggetlen teljes szöveges keresés

#Token kezelése

Az összes létrehozott token a Felhasználói profil → Integrációk áttekintésében látható. Itt a következőket látja:

A token nevének
A hozzárendelt jogosultságok
Amikor a tokent utoljára használták
A token visszavonásának lehetősége

Képernyőfotó: Token-áttekintés az aktív tokenekkel

#Fontos megjegyzések

Adathozzáférés: Az API-tokenek csak azokra az adatokra férnek hozzá, amikre a megfelelő felhasználónak is van hozzáférése. A felhasználó jogosultságai továbbra is érvényesek.
Biztonság: Soha ne ossza meg nyilvánosan az API-tokeneket. Tárolja a tokeneket környezeti változókban vagy egy titokkezelőben, ne a forráskódban.
Minimális jogosultság: Csak a minimálisan szükséges jogosultságokat adjon meg. Egy wiki-integrációhoz nem szükséges a csethez való hozzáférés.
Lejárati dátum: Ideiglenes integrációknál állítson be lejárati dátumot a biztonság növelése érdekében.
Visszavonás: Vonja vissza azonnal a nem szükséges tokeneket a token-áttekintésen keresztül.