Мини-приложения

Продукт
1. Зачем нужен продукт «Мини-приложения»?
2. Как происходит интеграция мини-приложения в суперапп?
3. Какие требования есть к мини-приложению? Какие возможности доступны в процессе интеграции?

Управление через CRM
4. Как выдать доступы на управление мини-приложениями через CRM?
5. Как зарегистрировать свое мини-приложение через CRM для интеграции в суперапп?
6. Как опубликовать или обновить мини-приложение? Как проходит его модерация?
7. Как переключаются статусы мини-приложения в CRM?

Приложение клиента
8. Как взаимодействие с мини-приложением будет выглядеть для клиента?

Продукт «Мини-приложения» — инструмент, который позволяет управляющим организациям и девелоперам самостоятельно расширять функционал супераппа.
Мини-приложение — программа (веб-приложение), которую клиент может запустить в основном приложении.

Управляющие организации и девелоперы (далее: партнеры) могут встроить такие программы в суперапп Домиленд. На главном экране супераппа есть возможность показать виджет для быстрого перехода к мини-приложению.
Причем внедрить можно не только собственное мини-приложение, но также приложения своих поставщиков и партнеров, создав дополнительный канал взаимодействия с пользователем.

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

1. Гибкость и масштабируемость. Мини-приложения позволяют не ограничивать потенциал бизнеса изначальным функционалом супераппа. Несмотря на всю широту возможностей последнего, его стандартные решения не всегда удовлетворяют специфические потребности каждой управляющей организации или девелопера. Тогда как мини-приложения дают эту гибкость и новые возможности для клиентов без долгой разработки. Поэтому продукт позволяет адаптироваться к различным вызовам индустрии: потребности клиентов, сезонный спрос, стратегия бизнеса, уникальные партнеры, экспериментальные решения.

2. Повышение прибыли и других показателей. Партнеры могут создать новые каналы дохода и повышать конверсию в оплату через сторонние сервисы, благодаря покупкам внутри своих мини-приложений. А также могут повышать и общую частоту использования сторонних сервисов за счет бесшовного перехода из приложения Домиленд.

3. Независимость. Партнеры способны обновлять мини-приложения своими силами. Это позволяет им добавлять новый функционал, уникальные сервисы или интеграции, не ожидая этих изменений в самом супераппе. Такой подход не только сокращает путь инноваций до потребителя, но и повышает удовлетворенность клиентов, предоставляя им доступ к последним разработкам без задержек и простоев.

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

5. Экономия. Разработать мини-приложение на основе готовых инструментов от Домиленд потребует гораздо меньше времени и средств, чем создавать полноценное решение с нуля.

Все эти преимущества не только усиливают ключевые бизнес-показатели, но также делают продукт ценным для формирования гибкой и модульной системы, способной адаптироваться к постоянно меняющимся условиям рынка и потребностям клиентов.

Управляющие организации и девелоперы могут разработать и разместить мини-приложение в супераппе при минимальном участии сотрудников Домиленд.

Процесс интеграции мини-приложения в суперапп состоит из следующих шагов:

1. Покупка лицензий. Партнер покупает лицензию на размещение мини-приложения в супераппе. При этом сотрудники Домиленд добавляют купленные лицензии в систему.
2. Разработка. Партнер разрабатывает мини-приложение до полностью работоспособного состояния.
3. Тестирование. Партнер локально проверяет мини-приложение на стабильность и корректность работы.
4. Регистрация. Партнер добавляет в CRM информацию о мини-приложении, которая необходима для прохождения модерации.
5. Сборка. Партнер собирает архив с мини-приложением, загружает его в CRM и отправляет на модерацию.
6. Модерация. Мини-приложение проходит модерацию, которую осуществляют сотрудники Домиленд.
7. Публикация. Партнер публикует мини-приложение, которое прошло модерацию.
8. Распространение. Партнер настраивает виджет, через который клиенты смогут открывать мини-приложение в супераппе.

В мини-приложении доступны следующие функциональные возможности:

• Отправить Push-уведомление клиенту. Атрибуты уведомления позволяют разработчику реализовать переход на конкретный экран внутри мини-приложения или скролл до якоря на экране. Описание API
• Получить данные о текущем пользователе. Благодаря этим данным, партнер через мини-приложение может предоставлять клиентам персонализированный контент и функционал в соответствии с их профилем. Описание API
• Провести оплату. Мини-приложение получает информацию о совершенной покупке после завершения оплаты. Партнер может использовать эти данные, чтобы обновить состояние заказа или показать клиенту информацию о покупке. Описание API
• Скачать или загрузить файл. Стандартный функционал веб-приложений, для которого не требуется использовать API.

Возможности API ограничены, но партнер может использовать следующую схему взаимодействия с мини-приложением:

1. Частично сохранять информацию о клиенте из системы Домиленд во внешней системе. Это реализуется через экспорт данных или вебхуки (моментальные уведомления о событиях в системе), которые описаны в документации Public API.
2. Когда клиент открывает мини-приложение, партнер получает данные текущего клиента через библиотеку JS SDK.
3. Благодаря тому, что после пунктов 1 и 2 известен идентификатор клиента, партнер через запрос на бэкенде связывает сохраненные данные с текущим клиентом.
4. И таким образом в мини-приложение можно передать дополнительные данные. Партнер отображает желаемую информацию в мини-приложении, в зависимости от известных данных клиента.

Ресурсы для интеграции:

• Необходимо использовать UI-кит от Домиленд, чтобы соответствовать фирменному стилю и структуре супераппа от Домиленд. Мини-приложение может не пройти модерацию, если не следует правилам дизайн-системы. Если партнер использует брендированное приложение, рекомендуется скопировать UI-кит в свое пространство Figma и заменить брендовые цвета. В UI-ките находятся инструкция по его использованию, а также набор различных элементов для применения в мини-приложениях: цвета, иконки, типографика, компоненты интерфейса.
• Необходимо использовать библиотеку JS SDK, чтобы взаимодействовать с API. Данная библиотека предоставляет разработчикам набор инструментов, которые упрощают интеграцию мини-приложения в суперапп. Мини-приложения не рассчитаны на интеграцию без использования этой библиотеки.
• Доступно техническое описание для разработчиков: взаимодействие через API между мини-приложением и супераппом, примеры кода.
• Чтобы еще больше упростить процесс интеграции, существует Демо-приложение, где показаны возможности интеграции мини-приложения в суперапп.

Требования к процессу интеграции:

• Чтобы получить данные клиента через мини-приложение, нужно использовать токен по стандарту JWT. Этот токен можно сгенерировать в карточке мини-приложения.
• Если на стороне супераппа возникает ошибка при попытке открыть мини-приложение, ее обрабатывает суперапп. Но разработчикам мини-приложения необходимо предусмотреть обработку тех ошибок, которые возникают внутри мини-приложения.

Каждому сотруднику назначена своя роль, и у каждой роли есть свой набор доступов.
Перейдите в настройки роли доступа «Настройки» → «Сотрудники» → вкладка «Роли доступа» → роль доступа (например, разработчик) → вкладка «Доступ» → группа доступов «Управление».

Поскольку, к продукту относится только один раздел CRM, в блоке «Управление» есть только одна настройка «Мини-приложения» для доступа к одноименному разделу.
Для раздела «Мини-приложения» есть права на отдельные действия в CRM:

• «Мини-приложения: Просмотр» — позволяет просматривать раздел со списком мини-приложений.
• «Мини-приложения: Редактирование и добавление» — позволяет добавлять мини-приложения в список, изменять их, публиковать новые версии.

Раздел CRM «Управление» → «Мини-приложения» позволяет добавить собственные мини-приложения в суперапп и управлять ими.

Чтобы добавить новое мини-приложение, нажмите кнопку «Добавить» над их списком. Далее в модальном окне нужно заполнить данные:

• Лицензия — через выпадающий список для выбора доступны лицензии, купленные организацией для размещения мини-приложений;
• Название — только буквы, цифры, дефисы и пробелы. Длина 5-128 символов;
• Категория — на выбор доступны категории: Образ жизни, Еда и напитки, Развлечения, Бизнес, Общение, Путешествия, Транспорт, Недвижимость, Образование, Мероприятия, Инструменты, Оплата услуг, Социальные, Игры, Другое;
• Описание — только буквы, цифры, дефисы и пробелы. Длина 5-500 символов.

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

Список мини-приложений в этом разделе упорядочен по дате их последнего обновления. Таблица содержит данные: название приложения, статус, категория и дата обновления. Нажав на строку, сотрудник откроет карточку мини-приложения.

Открыв карточку мини-приложения, необходимо продолжить заполнение данных. Там доступны две вкладки: «Основное», «Размещение и обновление».

На вкладке «Основное» доступно редактирование или просмотр следующих параметров:

• Статус приложения
• Лицензия — через выпадающий список для выбора доступны лицензии, купленные организацией для размещения мини-приложений. Сотрудники Домиленд добавляют лицензии в систему, когда организация покупает их. Ни одна лицензия не закреплена за «своим» конкретным мини-приложением. Но каждая должна соответствовать только одному из мини-приложений: если она уже выбрана для одного, то будет недоступна для других. Если очистить поле с лицензией, у приложения автоматически устанавливается статус «Неактивно». Названия лицензий отличаются друг от друга номерами, например: dmapp_6, dmapp_7, dmapp_8, и так далее.
• Название приложения
• Категория приложения
• Описание
• Договор оферты — необходимо загрузить оферту на использование мини-приложения. Клиент должен дать согласие с этой офертой, прежде чем сможет использовать мини-приложение. Здесь же есть возможность удалить оферту и заменить на новую.

Перечисленные данные нужны для прохождения модерации у сотрудников Домиленд и не видны клиентам, кроме договора оферты.

Сотрудник может включить опцию «Принимать оплату в мини-приложении», тогда нужно указать получателя денежных средств и расчетный счет (выбираются из юрлиц в системе).

Когда приложение прошло модерацию, на основной вкладке кнопкой «Сгенерировать» можно сформировать токен, необходимый для получения персональных данных клиента через мини-приложение.

Когда мини-приложение уже зарегистрировали через CRM, процесс его публикации состоит из следующих шагов:

1. Сотрудникам партнера нужно сделать сборку frontend-части проекта и заархивировать его в .zip формате.
2. В карточке мини-приложения на вкладке «Размещение и обновление» загрузить собранный архив с проектом.
3. Нажимая кнопку «Отправить на модерацию», партнер запросит разрешение интегрировать свое мини-приложение в суперапп.
4. Когда сотрудники Домиленд одобрили мини-приложение, оно примет статус «Готово к публикации» на вкладке «Размещение и обновление» появится кнопка «Опубликовать». Эта кнопка сменит статус мини-приложения на «Активно», после чего партнер сможет настроить виджет с мини-приложением, чтобы клиенты могли использовать его.

Кроме первичного размещения, мини-приложение должно пройти модерацию, если:

• партнер после самой первой проверки повторно изменил оферту на основой вкладке в карточке мини-приложения;
• партнер загрузил новую версию мини-приложения.

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

Статус мини-приложения отображается в его карточке на вкладке «Основное».
Мини-приложение может быть в следующих состояниях:

• Неактивно — статус при его добавлении в CRM.
• На модерации — при ручной отправке сборки на модерацию, либо при повторном изменении оферты для клиента.
• Готово к публикации — статус после прохождения модерации. Нельзя выбрать в CRM, его устанавливают сотрудники Домиленд.
• Тестируется — виджет с мини-приложением видят только клиенты с ролью «Тестировщик». Сотрудники в карточке клиента CRM могут включить галочку «Тестировщик», чтобы разрешить ему проверять, как обычные пользователи будут видеть функционал.
• Активно — мини-приложение доступно для размещения в виджете.

После первичной или повторной модерации сотрудники могут свободно менять состояние мини-приложения между тремя статусами: «Неактивно», «Активно», Тестируется».
До самой первой модерации есть возможность только загрузить архив со сборкой и отправить мини-приложение на проверку.

Клиент видит модальное окно с возможностью посмотреть и принять оферту, когда впервые открывает мини-приложение или после изменения оферты.
Если пользователь ее отклоняет, он вернется обратно на предыдущий экран. Факт принятия оферты сохраняется в системе. В дальнейшем суперапп проверяет согласие с актуальной версией оферты при повторных переходах в мини-приложение.

Если мини-приложение доступно для клиентов девелопера, оно видно авторизованным и не авторизованным пользователям. При попытке открыть мини-приложение неавторизованным пользователем происходит переход на экран авторизации, а после авторизации происходит возврат к мини-приложению.

API позволяет мини-приложению рассылать push-уведомления для клиентов, а они в свою очередь могут реагировать на них. Например, нажать на уведомление и открыть определенный экран мини-приложения, если пуш направляет на него. Но суперапп не хранит такие уведомления у себя, и они должны храниться внутри мини-приложения.

На скриншоте ниже: слева — модальное окно, в котором клиент подтверждает согласие с офертой на использование мини-приложения; справа — пример экрана в демо-версии мини-приложения от Домиленд.
Благодаря следованию дизайн-системе от Домиленд и использованию тех же компонентов, партнеры могут сделать незаметной разницу между супераппом и мини-приложением.