Публикация мини-аппа в панель сервисов VK Teams

Дополнительная документация

Общая информация — в документе описано, что такое мини-аппы, и как они выглядят в клиентском приложении VK Teams.

Техническое описание — в документе описаны принципы разработки мини-аппа, выполнение запросов, авторизация и отладка мини-аппа.

Создание мини-аппа — в документе описано создание мини-аппа в VK Teams с использованием библиотеки VK Teams Bridge.

Библиотека VK Teams Bridge — в документе описаны методы взаимодействия мини-аппа с нативным клиентом VK Teams.

Регистрация мини-аппа — в документе описана регистрация мини-аппа при помощи Метабота VK Teams.

FAQ — в разделе собраны часты вопросы при работе с мини-аппами.

Архитектура и описание системы — в документе представлена информация о сервисах VK Teams, обеспечивающих функциональность мини-аппов. Не является частью публичной документации, обратитесь к представителю VK Tech, чтобы ознакомиться с документом.

Общая информация

После создания веб-приложения и его успешной регистрации в Метаботе вы можете опубликовать мини-апп в навигационную панель VK Teams. Таким образом мини-апп станет доступен всем пользователям при клике на иконку в сервисах VK Teams.

Мини-апп открывается в интерфейсе на всё рабочее пространство клиентского приложения.

Если мини-апп зарегистрирован в Метаботе, но не опубликован, пользователи могут работать с мини-аппом при помощи прямой ссылки. Ссылкой можно поделиться с другими пользователями, пример ссылки: https://u.internal.myteam.mail.ru/miniapp/miniapp-16c6c83e-075f-4d92-b840-ad1991f3445c.

Вы можете опубликовать мини-апп двумя способами:

1. Через Панель администратора VK WorkSpace (при её наличии).
2. Через выполнение запросов к API мини-аппов.

Публикация мини-аппа через Метабота недоступна.

Публикация из Панели администратора VK WorkSpace

1. Перейдите в раздел Мессенджер → Мини-аппы.

2. Откройте необходимый мини-апп из списка и выберите Опубликовать.

В течение часа (по мере скачивания обновлённого конфига) мини-апп появится у пользователей в клиентских приложениях.

Публикация через API мини-аппов

Если в инсталляции нет Панели администратора VK Workspace, опубликовать мини-апп можно при помощи запросов к API VK Teams.

Для работы с API необходимы:

1. Доступ в окружение администратора — интерфейс администратора доступен только пользователям, добавленным в группу с доступом в окружение администратора. Управление пользователями описано в документе Руководстве по администрированию.
2. Авторизация в окружении администратора.

Чтобы опубликовать мини-апп:

1. Сгенерируйте OTP при помощи команды:

   curl 'https://admin.<company_domain>/auth/otp/generate' \
   -H 'Content-Type: application/json' \
   -d '{"email": "admin@company_domain"}'
   

   где admin@company_domain — пользователь с доступом в окружение администратора.

   OTP придет на почту пользователя с доступом в окружение администратора.

2. Проверьте OTP:

   curl 'https://admin.<company_domain>/auth/otp/check' \
   -H 'Content-Type: application/json' \
   -d '{"email": "admin@company_domain", "password": "OTP"}' \
   -c cookiefile.txt
   

   где:

   • admin@company_domain — пользователь с доступом в окружение администратора.
   • password — OTP, сгенерированный на шаге 1.

3. Посмотрите зарегистрированные мини-аппы:

   curl 'https://admin.<company_domain>/api/miniapp/list' \
   -H "accept: application/json" \
   -H "Content-Type: application/json" \
   -b cookiefile.txt \
   -d ''
   

4. Опубликуйте мини-апп:

   curl 'https://admin.<company_domain>/api/miniapp/enable' \
   -H "accept: application/json" \
   -H "Content-Type: application/json" \
   -b cookiefile.txt \
   -d '{"miniappId":"miniapp-04c4ec24-2237-4a8f-934e-4ad1ef07f45f"}'
   

   где miniappId — ID мини-аппа, который нужно опубликовать. Можно узнать в Метаботе при помощи команды /myapps.