Kibi API

Kibi REST API дозволяє зовнішнім програмам, штучним інтелектам та автоматизаціям отримувати доступ до даних Kibi Connect. Через API можна читати та записувати вміст — від вікі-сторінок до новин, завдань і записів календаря.

#Активувати доступ до API

REST API спочатку має бути активовано системним адміністратором. Налаштування знаходиться за адресою:

Налаштування → Інтеграції → REST API

Тут доступні такі опції:

Активувати REST API

Увімкнення або вимкнення API-інтерфейсу.
Обмежити створення токенів певними ролями

Якщо активовано, лише користувачі з вибраними ролями можуть створювати API-токени. Окремі користувачі можуть додатково отримувати дозвіл через доступ до функцій у вкладці безпеки свого профілю.
Активувати обмеження за IP

Якщо активовано, лише вказані IP-адреси можуть отримувати доступ до API. Це додатковий рівень безпеки.

Скріншот: Налаштування API в розділі Інтеграції

#Створити API-токен

Кожен користувач може створювати власні API-токени через свій профіль. Для цього перейдіть до:

Профіль користувача → Інтеграції → Створити новий токен

Під час створення токена вкажіть:

Назва

Описова назва (наприклад, «AI-агент», «ERP-інтеграція», «Автоматизація робочого процесу»).
Дозволи (Scopes)

Оберіть лише ті дозволи, які дійсно потрібні інтеграції (принцип мінімальних привілеїв).
Термін дії (необов’язково)

За бажанням можна встановити термін дії, після якого токен автоматично стане недійсним.

Скріншот: Форма створення токена з вибором дозволів

#Безпечно зберігайте токен

Після створення значення токена показується лише один раз. Невідкладно скопіюйте його та збережіть у безпечному місці (наприклад, у менеджері паролів). У разі втрати токен потрібно скасувати та створити новий.

Скріншот: Токен після створення — видно лише один раз

#Доступні дозволи (Scopes)

Наступні Scopes керують доступом API-токена до різних областей:

Scope	Опис
`posts:read`	Читання опублікованих дописів і новин
`posts:write`	Створення, оновлення та видалення дописів
`wiki:read`	Читання вікі-сторінок і документації
`wiki:write`	Створення та оновлення вікі-сторінок
`calendar:read`	Читання записів календаря
`calendar:write`	Створення, оновлення та видалення записів календаря
`groups:read`	Читання публічних груп, учасників, дописів і файлів
`surveys:read`	Читання опитувань і результатів
`tasks:read`	Читання завдань (лише власних або призначених)
`tasks:write`	Створення та оновлення завдань
`users:read`	Читання публічного довідника користувачів (без приватних даних)
`chat:read`	Читання розмов і повідомлень
`chat:write`	Надсилання повідомлень (для ботів і автоматизацій)
`notifications:read`	Читання сповіщень користувачів
`notifications:write`	Надсилання сповіщень користувачам (включно з push-сповіщеннями)
`search`	Пошук по всіх сутностях

#Аутентифікація API

Усі запити до API мають містити токен як Bearer-токен у заголовку Authorization:

curl -H "Authorization: Bearer kbc_ВашТокенТут" \
     https://ваша-компанія.kibi.de/api/v1/wiki

Базова URL-адреса API: https://ваша-компанія.kibi.de/api/v1

#Доступні кінцеві точки

Повна документація API з усіма кінцевими точками та параметрами доступна безпосередньо в Kibi Connect за адресою:

Інтерактивна документація: Профіль користувача → Інтеграції → Документація API
Специфікація OpenAPI (JSON): Профіль користувача → Інтеграції → OpenAPI JSON

Огляд основних кінцевих точок:

Область	Кінцева точка	Опис
Вікі	`GET /wiki`	Список вікі-сторінок
Вікі	`POST /wiki`	Створення вікі-сторінки
Новини	`GET /posts`	Список дописів
Завдання	`GET /tasks`	Список завдань
Календар	`GET /calendar/events`	Список записів календаря
Чат	`POST /chat/direct`	Надсилання особистого повідомлення
Користувачі	`GET /users`	Список довідника користувачів
Пошук	`GET /search`	Повнотекстовий пошук по всіх сутностях

#Керування токенами

Усі створені токени відображаються в огляді за адресою: Профіль користувача → Інтеграції. Тут ви бачите:

Назву токена
Надані дозволи
Коли токен використовувався востаннє
Можливість скасувати токен

Скріншот: Огляд токенів з активними токенами

#Важливі зауваги

Доступ до даних: API-токени мають доступ лише до тих даних, до яких має доступ відповідний користувач. Дозволи користувача залишаються чинними.
Безпека: Ніколи не діліться API-токенами публічно. Зберігайте токени в змінних оточення або в менеджері секретів, а не в вихідному коді.
Мінімальні привілеї: Надавайте лише мінімально необхідні дозволи. Токен для інтеграції вікі не потребує доступу до чату.
Термін дії: Для тимчасових інтеграцій встановлюйте термін дії, щоб підвищити безпеку.
Скасування: Невідкладно скасовуйте токени, які більше не потрібні, через огляд токенів.