6. Интеграция действий в приложении
Убедитесь, что эти шаги выполнены успешно:
Для передачи данных о действиях клиента нужно завести «операции» Подробно о них в разделе “Операции и интеграции” на help.mindbox.ru.
Для вызова операций из мобильного приложение Mindbox SDK предлагает 2 метода:
executeAsyncOperation— передача данных в систему;executeSyncOperation— получение данных из системы.
Для создания тела запроса при вызове операции нужно использовать конструктор OperationBodyRequest.
Техническое задание на интеграцию
Эта страница — пример того, как вызывать API SDK для передачи данных.
Для передачи данных в Mindbox сначала надо настроить нужные методы API. Это делается индивидуально для каждого проекта.
Менеджер проекта со стороны Mindbox настраивает нужные методы и описывает их в специальном документе.
Не приступайте к этому разделу, если у вас нет документа с описанием всех нужных методов.
Пример реализации вызовов по сценариями
Авторизация в приложении
Code
Передача действий просмотра продуктов и категорий
Code
Передача действий добавления и установки списка продуктов
Для работы со списком продуктов Mindbox предлагает 2 варианта подхода:
- добавление/удаление по 1 шт;
- установка списка одним запросом
Популярные списки продуктов: «корзина» и «избранное».
Code
Пример проверки клиента в сегменте
Данный запрос проверяет принадлежность клиента к заранее настроенному сегменту в системе.
Code
Пример получения персональных рекомендаций
Данный запрос возвращает список продуктов, подобранных клиенту на основе одного из настроенных алгоритмов продуктовых рекомендаций.
Code
Подробное описание вызова executeAsyncOperation
Для передачи данных в Mindbox через асинхронные операции, можно использовать метод SDK Mindbox.executeAsyncOperation.
Этот метод принимает:
- системное имя операции;
- тело запроса в Mindbox.
Инструкция по вызову Mindbox.executeAsyncOperation
Описание метода
Code
Пример вызова
Code
Проверка выполнения инструкции
- Создайте операцию в админке;
- Интегрируйте вызов
Mindbox.executeAsyncOperationв вашем приложении, например, по нажатию кнопки; - Запустите приложение и выполните целевое действие;
- Найдите своего пользователя в системе и проверьте, что у него в «действиях» появилась ожидаемая запись.
Дебаг стандартных ошибок — здесь.
Подробное описание вызова executeSyncOperation
Для выполнения синхронных операций можно использовать метод Mindbox.executeSyncOperation.
Этот метод принимает:
- системное имя операции;
- тело запроса в Midnbox;
- коллбек, который надо вызвать, если операция выполнится успешно;
- коллбек, который надо вызвать, если операция выполнится с ошибкой.
В коллбеки передается типизированный объект, в который парсится ответ от Mindbox.
Если по каким-то причинам ответ от Mindbox не может обработаться структурами, которые заложен в SDK, вы можете реализовать собственный класс для обработки ответа.
Он передается отдельным параметром в вызов функции.
Использование готового класса
Описание метода
Code
В таком случае, для запроса используется параметры operationSystemName и operationBody.
Ответом на запрос является сущность Result<OperationResponse, MindboxError>.
Пример
Code
Расшифровка ответа
OperationResponse — модель, которая имеет в себе перечисление всех возможных полей ответа от сервера. Все поля опциональны.
MindboxError — модель ошибки, которую возвращает Mindbox. Возможные вариации ошибок от сервера:
validationErrorсодержит в себе модельValidationError. Указывает на поля, которые были заполнены неправильно.protocolErrorсодержит в себе модельProtocolError. Возвращается в случае ответа от сервера со статусами4XXа также некоторые ошибки5XX.serverErrorвозвращается в случае5ХХстатуса без данных от сервера.connectionError— ошибка запроса по причине соединения.invalidResponseвозвращается в случае невалидного ответа от сервера.internalErrorуказывает на ошибки конфигурацииMindbox, ошибки декодирования ответа и прочие.unknownвозвращается в случае непредвиденного поведения со вложенным типомError.
Для отладки ошибок используйте параметр errorDescription.
Как прошла ваша интеграция SDK Mindbox?
Мы подготовили короткий опрос, чтобы вы могли поделиться своим опытом интеграции SDK Mindbox. Ваши ответы помогут нам сделать продукт и процесс интеграции лучше!