Время чтения 3min

Kibi API

Автоматически переведено

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

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

REST API должен быть сначала активирован администратором системы. Настройка находится в:

Настройки → Интеграции → REST API

Здесь доступны следующие опции:

  • Активировать REST API

    Включает или отключает API-интерфейс.

  • Ограничить создание токенов определенными ролями

    Если активировано, только пользователи с выбранными ролями могут создавать API-токены. Отдельные пользователи могут быть дополнительно уполномочены через доступ к функциям во вкладке безопасности их профиля.

  • Активировать ограничение по IP

    Если активировано, только указанные IP-адреса могут получать доступ к API. Это дополнительный уровень безопасности.

Скриншот: Настройки API в разделе Интеграции

#Создание API-токена

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

Профиль пользователя → Интеграции → Создать новый токен

При создании токена укажите:

  • Имя

    Описательное имя (например, "ИИ-агент", "ERP-интеграция", "Автоматизация рабочих процессов").

  • Разрешения (Scopes)

    Выберите только те разрешения, которые действительно необходимы интеграции (принцип минимальных привилегий).

  • Срок действия (необязательно)

    Можно установить срок действия, после которого токен автоматически станет недействительным.

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

#Безопасное хранение токена

После создания значение токена отображается только один раз. Немедленно скопируйте его и сохраните в надежном месте (например, в менеджере паролей). В случае потери токен должен быть отозван, и нужно создать новый.

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

#Доступные разрешения (Scopes)

Следующие области управления определяют доступ API-токена к различным разделам:

Область

Описание

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

Обзор основных конечных точек:

Область

Конечная точка

Описание

Wiki

GET /wiki

Список вики-страниц

Wiki

POST /wiki

Создание вики-страницы

Новости

GET /posts

Список публикаций

Задачи

GET /tasks

Список задач

Календарь

GET /calendar/events

Список записей календаря

Чат

POST /chat/direct

Отправка личного сообщения

Пользователи

GET /users

Список справочника пользователей

Поиск

GET /search

Полнотекстовый поиск по всем сущностям

#Управление токенами

Все созданные токены отображаются в обзоре в разделе Профиль пользователя → Интеграции. Здесь вы видите:

  • Имя токена

  • Назначенные разрешения

  • Когда токен использовался в последний раз

  • Возможность отозвать токен

Скриншот: Обзор токенов с активными токенами

#Важные замечания

  • Доступ к данным: API-токены имеют доступ только к тем данным, к которым имеет доступ соответствующий пользователь. Права пользователя остаются в силе.

  • Безопасность: Никогда не делитесь API-токенами публично. Храните токены в переменных окружения или в менеджере секретов, а не в исходном коде.

  • Минимальные привилегии: Назначайте только минимально необходимые разрешения. Токену для интеграции с вики не нужен доступ к чату.

  • Срок действия: Для временных интеграций устанавливайте срок действия, чтобы повысить безопасность.

  • Отзыв: Немедленно отзывайте токены, которые больше не нужны, через обзор токенов.