Обзор

Подключение к платформе MAX для партнёров и сервисам платформы — чат-ботам, мини-приложениям, каналам — пока доступно для ограниченного списка юрлиц и ИП

Мини-приложения работают только внутри MAX и не могут существовать автономно. Они расширяют функциональность основной платформы и позволяют разработчикам быстро запускать проекты

Что потребуется

• Устройства с операционной системой Windows, macOS или Linux
• Мобильное устройство для регистрации профиля в MAX
• Редактор кода и навыки работы с командной строкой

Что упростит разработку

• Библиотека MAX Bridge, с которой мини-приложение сможет взаимодействовать с API MAX и API устройства пользователя
• Библиотека React-компонентов MAX UI, с которой мини-приложение легко стилизовать под интерфейс MAX
• Мини-приложения работают на базе стандартных веб-технологий — HTML, JavaScript, CSS

Перед подключением

• Загрузите файлы мини-приложения на хостинг статики, например, через Vercel или GitHub Pages — .html, .css, .js и другие медиафайлы
• Проверьте, что приложение работает по защищённому соединению — https

Как добавить приложение в MAX

1. Откройте платформу MAX для партнёров → выберите нужный чат-бот
2. Перейдите в раздел Чат-бот и мини-приложение → Настроить
3. Вставьте URL мини-приложения в поле для ссылки и нажмите Сохранить

Требования к URL мини-приложения:

• Длина: не более 1024 символов
• Протокол: только https://
• Допустимые символы: буквы (латиница), цифры, точка (.) и дефис (-)
• Пробелы запрещены
• URL должен быть валидный

Как только вы подключите мини-приложение к платформе, в чате с его ботом появится заметная кнопка для быстрого запуска сервиса

Запуск мини-приложения из чата с ботом

Как управлять приложением

Обновление ссылки на приложение

Если ссылка поменялась, самостоятельно обновите её на платформе MAX для партнёров: зайдите в личный кабинет организации → перейдите в раздел Чат-бот и мини-приложение → Настроить → в поле с URL обновите ссылку → нажмите Сохранить

Удаление приложения

Если вы хотите удалить мини-приложение, удалите ссылку на него в платформе MAX для партнёров: зайдите в личный кабинет организации → перейдите в раздел Чат-бот и мини-приложение → Настроить → в поле с URL удалите ссылку → нажмите Сохранить

Как открыть приложение по прямой ссылке

Каждое мини-приложение можно открыть внутри MAX по ссылке вида: https://max.ru/<botName>?startapp

После ключа ?startapp в ссылку можно добавить стартовые параметры. Они будут переданы мини-приложению в поле start_param и в GET-параметре WebAppStartParam

Подробнее о стартовых параметрах читайте в разделе WebAppStartParam

Если у вас возникли вопросы, посмотрите раздел с ответами