Документация по разработке собственных дополнений для серверной версии

Теперь разработчики могут создавать собственные дополнения для серверной версии Kaiten — в документации Kaiten Enterprise появилось пошаговое руководство: от подключения Web SDK до доступа к REST API.

Функциональность находится в стадии Beta.

Раньше разработка дополнений была доступна только для облачной версии Kaiten. Теперь разрабатывать и подключать собственные дополнения можно и внутри закрытого контура серверной версии.

Мы разработали документацию, внутри которой собраны инструкции по созданию, настройке и развертыванию собственных дополнений, а также работе с Web SDK и API Kaiten.

Что входит в руководство

В разделе Собственные дополнения (beta) собраны страницы с описанием того, как устроено дополнение и что оно умеет:

• подключение Web SDK и инициализация дополнения;

• описание всех методов Web SDK — каждому посвящена отдельная страница;

• возможности дополнения — по каждой отдельная страница:

  • экран настроек (settings)

  • кнопки в карточке (card_buttons)

  • секция в теле карточки (card_body_section)

  • бейджи на фасаде карточки (card_facade_badges)

• работа с данными и секретами дополнения;

• элементы интерфейса — поп-апы, диалоги, уведомления, оформление под тему Kaiten;

• авторизация со сторонними сервисами через OAuth;

• доступ к публичному REST API Kaiten от имени пользователя;

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

Чтобы дополнение могло обращаться к Kaiten API от имени пользователя, можно воспользоваться API клиентом встроенным в Web SDK context.getApiClient() и использовать его методы для авторизации и отправки запросов.

Отдельно собрали справочник всех методов Web SDK: точки входа, методы контекста и работы с Kaiten API. Каждый метод описан на своей странице с параметрами и тем, что он возвращает.

Кроме этого мы добавили отдельные страницы по настройке дополнений для Docker и Kubernetes, где вы найдете информацию, как сгенерировать секреты и задать переменные окружения, чтобы дополнения на вашей инсталляции могли получать токены к API.

Это полноценное рабочее дополнение с кодом и структурой файлов: его можно собрать и запустить в своем контуре, а потом взять за основу для собственной разработки. Таймер добавляет в карточку кнопки старта и остановки, сохраняет отсчитанное время и показывает историю замеров.

Где найти документацию

• Дополнительно → Собственные дополнения (beta) — руководство по разработке дополнений.

• Установка и развертывание → Docker → Дополнения с API (beta) — настройка для Docker.

• Установка и развертывание → Kubernetes → Дополнения с API (beta) — настройка для Kubernetes.

Все новые разделы помечены как beta.

Полезные ссылки

• Документация Kaiten Enterprise

• Дополнения и расширения

• Модуль «Дополнения» для серверной версии