Comment on page
Мобильный SDK
Loymax предоставляет SDK для интеграции мобильных приложений с платформой Loymax SmartCom. SDK реализован для Kotlin и Swift. Данный SDK по своей сути является оберткой, которая осуществляет вызовы в бакенд Loymax.
SDK содержит методы:
- getPopup(clientId, action, sourceID) – получить из Loymax SmartCom информацию о попапе, который необходимо показать;
- viewPopup(clientId, popupID, sourceID) – зафиксировать факт показа попапа;
- event(clientId, eventCode, eventData, sourceID) – зафиксировать факт события.
Во избежание влияния сетевых проблем на работу мобильного приложения разработчикам рекомендуется вызывать методы мобильного SDK в отдельном потоке и обрабатывать возможные исключения, возвращаемые методами.
Метод получает на вход:
- clientId - идентификатор клиента в ПЛ;
- action – идентификатор целевого действия;
- sourceID – идентификатор источника событий, не обязательный (например, когда у Партнера несколько мобильных приложений).
Метод возвращает null, если ничего показывать не надо, либо, в противном случае, массив, содержащий информацию:
- Идентификатор попапа (popupID);
- Действие Navlink;
- Значение для действия;
- Заголовок;
- Подзаголовок;
- Ссылка на изображение;
- Текст;
- Текст кнопки;
- Доп.текст (например, промокод);
- Код цвета1;
- Код цвета2.
При возникновении сетевой проблемы метод выбрасывает исключение.
Данный метод необходимо вызывать при каждом переходе клиента на другую карточку в приложении, а также при совершении иных целевых действий (например, удаление из корзины, очистка корзины и тд).
Ответственность за отрисовку попапа лежит на приложении. Это позволяет упростить процесс стилизации попапов.
Метод получает на вход:
- clientId - идентификатор клиента в ПЛ;
- popupID – идентификатор попапа;
- sourceID – идентификатор источника событий, не обязательный (например, когда у Партнера несколько мобильных приложений).
При возникновении сетевой проблемы метод выбрасывает исключение.
Данный метод необходимо вызывать после отрисовки (показа) попапа, чтобы зафиксировать факт попапа и удалить его из назначенных к показу текущему клиенту.
Метод получает на вход:
- clientId - идентификатор клиента в ПЛ;
- eventCode – код события;
- eventData – детали события, массив;
- sourceID – идентификатор источника событий, не обязательный (например, когда у Партнера несколько мобильных приложений).
Возможные значения пар eventCode/eventData:
Событие | eventCode | eventData |
|---|---|---|
Авторизация или регистрация | user_login | |
Просмотр карточки в МП | view_page | name: 'PAGE_NAME' |
Пр осмотр продуктовой категории | view_category | category_id: 'CATEGORY_ID' |
Просмотр продукта | view_product | category_id: 'CATEGORY_ID', product_id: 'PRODUCT_ID' |
Добавление продукта в корзину | add_to_cart | category_id: 'CATEGORY_ID', product_id: 'PRODUCT_ID', quantity: float, price: float |
Удаление продукта из корзины | remove_from_cart | product_id: 'PRODUCT_ID', quantity: float |
Очистка корзины | clear_cart | |
Завершение оформления заказа | order_complete | order_id: 'ORDER_ID' |
Регистрация произвольного события | event | name: 'EVENT_NAME', context: 'JSON' |
При возникновении сетевой проблемы метод выбрасывает исключение.
Last modified 3mo ago