Для разработчиков

Витрина

Витрина — вкладка Обзор в разделе Интеграции > Боты. Это каталог ботов вашего пространства: здесь сотрудники находят ботов, которыми можно пользоваться, и подключают их сами, без администратора. Витрину видят сотрудники, администраторы и мульти-гости.

Пока в витрине нет ни одного бота, на вкладке Обзор объясняется, что такое боты и витрина, и есть ссылки на документацию. Тем, кто может создавать интеграции, там же видны кнопки быстрого старта: одно нажатие создаёт бота с входящим вебхуком GitLab, Grafana или обычным и открывает его карточку. Пока ботов в витрине не больше пяти, эти кнопки остаются внизу вкладки в строке Подключить ещё.

Витрина общая только внутри пространства: в ней боты вашей компании, а бота из другой компании не видно и авторизовать нельзя.

Витрина ботов на вкладке «Обзор»

Карточки и список

Наверху вкладки — карточки опубликованных ботов с авторизацией. На карточке имя и аватар бота, отметка Подключено, если вы уже авторизовали бота, описание, создатель и кнопка Сообщение, если вы можете написать боту. У бота, которого вы можете редактировать, на карточке есть меню с пунктом Редактировать.

Ниже — список Публичные боты: имя, ник и кнопка Сообщение у каждого.

КарточкиПубличные боты
Кто попадаетБоты с авторизацией, которых опубликовали в витринеВсе боты с включённым переключателем Публичный бот
Что нужно от ботаВключённая авторизация и сохранённое описание, скриншоты по желаниюНичего, кроме публичности
Что открывает нажатиеСтраницу ботаПрофиль бота

Публичность и публикация — независимые настройки. Бот, который и опубликован, и публичный, показывается один раз — карточкой.

Страница бота

У бота с авторизацией есть своя страница в витрине.

Страница бота в витрине

На ней:

  • имя, аватар и создатель бота;
  • описание — чем бот занимается и зачем его подключать;
  • до пяти скриншотов;
  • Что бот может запросить — права, которые бот попросит на экране согласия: больше этого он не запросит;
  • отметка Подключено, если вы уже авторизовали бота, и кнопка Сообщение, если вы можете ему написать.

Как опубликовать бота

Заполняют страницу и публикуют бота его создатель и администраторы пространства, если бот открыт им для редактирования. Всё делается на вкладке OAuth в карточке бота: откройте бота на вкладке Управление и перейдите на неё.

Включите авторизацию

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

Заполните страницу на витрине

В блоке Страница на витрине введите описание — чем бот занимается и зачем его подключать — и нажмите Сохранить под полем. Описание видно на карточке бота и на его странице. Если нужно, добавьте кнопкой Добавить до пяти скриншотов PNG или JPG с соотношением сторон 16:9: они сохраняются сразу, порядок меняется перетаскиванием, а нажатие на скриншот открывает меню с пунктами Обновить изображение и Удалить.

Блок «Страница на витрине» на вкладке «OAuth»

Опубликуйте

Включите Опубликовать в витрине в начале того же блока — бот появится карточкой на вкладке Обзор. Пока описание не сохранено, переключатель недоступен, а под ним написано «Сначала добавьте описание».

Через API те же шаги делают поля oauth_client и promo метода PUTРедактирование бота — подробнее в разделе Настройка авторизации.

Публикация в витрине не даёт права написать боту. Авторизация проходит в разговоре с ботом, поэтому сделайте опубликованного бота публичным на вкладке Основное. Кто может написать боту — в разделе Доступы к чатам и сообщениям.

Чтобы убрать бота из витрины, выключите Опубликовать в витрине. Удаление OAuth-клиента на той же вкладке ещё и отзывает все выданные авторизации — подробнее в разделе Настройка авторизации.

Как сотрудник подключает бота

Сотрудник нажимает Сообщение на карточке бота и пишет ему, бот отвечает кнопкой авторизации, а сотрудник соглашается на экране согласия. После этого у бота в витрине появляется отметка Подключено. Путь по шагам — в разделе Как это выглядит для сотрудника.

Что должно быть включено у бота, чтобы этот путь сработал, — в Чек-листе запуска. Выданные авторизации сотрудник видит и отзывает на странице Интеграции > API — подробнее в разделе Согласие и отзыв.