Mindbox Quick Start Descriptions

CardsMobile.md

Кошелек

В рамках сценария заведется

Точка контакта: CardsMobileApp с названием Приложение Кошелёк

Точка интеграции: {{projectName}}-CardsMobile с названием Приложение Кошелёк с дополнительными настройками:

• Во всех брендах, если есть бренды
• Подтверждение телефонов
• Авторизация и доступ к аккаунту через мобильный телефон

Шаблоны действий:

• Кошелек. Промо пуш доставлен
• Кошелек. Промо пуш открыт
• Кошелек. Транзакционный пуш доставлен
• Кошелек. Транзакционный пуш открыт

Сегменты действий:

• Изменения баланса
• Все заказы

Тип дисконтной карты:

• Электронные карты

Операции

• Кошелек. Активация карты в приложении - CardsMobile.ActivateCard
• Кошелек. Выгрузить дисконтные карты - CardsMobile.GetDiscountCards
• Кошелек. Выдача карты в приложении (доступная из пула) - CardsMobile.BindCardFromPool
• Кошелек. Выдача карты в приложении - CardsMobile.BindCard
• Кошелек. Промо пуш доставлен - CardsMobile.PromoPushDelivered
• Кошелек. Промо пуш открыт - CardsMobile.PromoPushOpened
• Кошелек. Транзакционный пуш доставлен - CardsMobile.TransactionalPushDelivered
• Кошелек. Транзакционный пуш открыт - CardsMobile.TransactionalPushOpened
• Кошелек. Получение доступных промоакций в приложении - CardsMobile.GetAvailablePromotions
• Кошелек. Получение информации о покупателе в приложении - CardsMobile.GetCustomerInfo
• Кошелек. Получение информации по карте - CardsMobile.GetDiscountCard
• Кошелек. Получение истории заказов в приложении - CardsMobile.GetCustomerOrders
• Кошелек. Получение истории изменений баланса в приложении - CardsMobile.GetCustomerBalanceHistory
• Кошелек. Проверка наличия покупателя в приложении - CardsMobile.CheckCustomer
• Кошелек. Регистрация в приложении - CardsMobile.RegisterCustomer
• Кошелек. Редактирование потребителя в приложении - CardsMobile.EditCustomer

ecommerce.md

Описание сценария с базовыми сценариями для интернет магазина

В рамках сценария заведется

Точка контакта: Сайт - Site

Точка интеграции: {Project name}-website без дополнительных настроек

Списки продуктов:

• Корзина - Cart
• Избранное - Favorites

Дополнительные поля:

• Клиент - Идентификатор на сайте - WebsiteID
• Заказ - Идентификатор заказа на сайте - WebsiteID
• Заказ - Способ доставки - DeliveryType

Статусы позиции заказа:

• Создан - Create - Категория “Оформлена”

Операции

• Клиент - Регистрация на сайте - Website.RegisterCustomer
• Клиент - редактирование данных в ЛК - Website.EditCustomer
• Клиент - Авторизация в ЛК - Website.AuthorizeCustomer
• Подписка - в попапе - Website.SubscriptionInPopUp
• Подписка - в футере - Website.SubscriptionInFooter
• Заказ - смена статуса - Website.UpdateOrderStatus
• Заказ - создание авторизованным - Website.CreateAuthorizedOrder
• Заказ - создание неавторизованным - Website.CreateUnauthorizedOrder
• Избранное - добавление товара - Website.AddToWishList
• Избранное - убрать из списка - Website.RemoveFromWishList
• Избранное - установка списка - Website.SetWishList
• Каталог - просмотр категории - Website.ViewCategory
• Каталог - просмотр продукта - Website.ViewProduct
• Корзина - установка списка - Website.SetCart

Frontol.md

Кассы Фронтол

https://help.mindbox.ru/docs/интеграция-frontol

В рамках сценария заведется

Точка контакта: Административный сайт

Точка интеграции: {{projectName}}-Frontol с названием {{projectName}}-Frontol. Доступна во всех брендах, если есть бренды

Операции

• Клиент - регистрация (заводится без отправки смс с кодом авторизации) - Frontol.RegisterCustomer
• Клиент - получение данных о клиенте - Frontol.GetCustomerInfo
• Пречек - авторизованный - Frontol.AuthorizedPreorder
• Пречек - аноним - Frontol.AnonymousPreorder
• Процессинг чека - Авторизованный - Frontol.BeginAuthorizedOrderTransaction
• Процессинг чека - Аноним - Frontol.BeginAnonymousOrderTransaction
• Коммит - подтверждение чека - Frontol.CommitOrderTransaction
• Ролбек - откат чека - Frontol.RollbackOrderTransaction
• Отложенная обработка чека - Frontol.SaveOfflineOrder
• Отмена заказа - Frontol.CancelOrder
• Возврат позиции заказа - Frontol.Return
• Подтверждение мобильного телефона клиента - Frontol.CommitRegisterCustomer
• Подтверждение регистрации клиента - Frontol.ConfirmRegister
• Код авторизации - отправка (заводится без отправки смс с кодом авторизации) - Frontol.SendMobilePhoneAuthorizationCode

loyaltyOffline.md

Лояльность на кассе

В рамках сценария заведется

Точка контакта: Кассы

Точка интеграции: {{projectName}}-offline с названием ПЛ на кассах {{projectName}}. Доступна во всех брендах, если есть бренды

Операции

• Клиент - регистрация - Offline.RegisterCustomer
• Клиент - редактирование - Offline.EditCustomer
• Клиент - проверка - Offline.CheckCustomer
• Пречек - авторизованный - Offline.AuthorizedPreorder
• Пречек - аноним - Offline.AnonymousPreorder
• Пречек - не авторизованный - Offline.UnauthorizedPreorder
• Процессинг чека - Авторизованный - Offline.BeginAuthorizedOrderTransaction
• Процессинг чека - Аноним - Offline.BeginAnonymousOrderTransaction
• Процессинг чека - Не авторизованный - Offline.BeginUnauthorizedOrderTransaction
• Коммит - подтверждение чека - Offline.CommitOrderTransaction
• Ролбек - откат чека - Offline.RollbackOrderTransaction
• Отложенная обработка чека - Offline.SaveOfflineOrder
• Возврат позиции заказа - Offline.Return
• Код подтверждения - переотправка - Offline.ResendMobilePhoneConfirmationCode
• Код подтверждения - проверка - Offline.ConfirmMobilePhone
• Код авторизации - отправка - Offline.SendMobilePhoneAuthorizationCode
• Код авторизации - проверка - Offline.CheckMobilePhoneAuthorizationCode
• Карты - выдача - Offline.ActivateDiscountCard
• Карты - замена - Offline.ReplaceCards
• Карты - получить - Offline.GetCustomerCards

loyaltyOnline.md

Лояльность на сайте

В рамках сценария заведется

Точка контакта: Сайт ПЛ

Точка интеграции: {{projectName}}-website-loyalty с названием ПЛ на сайте {{projectName}}. Доступна во всех брендах, если есть бренды

Дополнительные поля:

• Клиент - Идентификатор на сайте - WebsiteID

Операции

Обратите внимание: если ранее на проекте были заведены базовые операции для интернет-магазина, перед заведением для лояльности нужно удалить операции, чье системное имя соответствует перечисленным ниже.

Если интеграция уже работает, удаление операций может привести к ошибкам. Для помощи в миграции обратитесь к вашему менеджеру.

• Клиент - регистрация - Website.RegisterCustomer
• Клиент - авторизация в ЛК - Website.AuthorizeCustomer
• Клиент - редактирование - Website.EditCustomer
• Клиент - проверка - Website.CheckCustomer
• Получить информацию о клиенте - Website.GetCustomerInfo
• Пречек - авторизованный - Website.AuthorizedPreorder
• Пречек - не авторизованный - Website.UnauthorizedPreorder
• Процессинг чека - Авторизованный - Website.BeginAuthorizedOrderTransaction
• Процессинг чека - Не авторизованный - Website.BeginUnauthorizedOrderTransaction
• Коммит - подтверждение чека - Website.CommitOrderTransaction
• Ролбек - откат чека - Website.RollbackOrderTransaction
• Процессинг - офлайн заказ - Website.SaveOfflineOrder
• Возврат позиции заказа - Website.Return
• Код подтверждения - переотправка - Website.ResendMobilePhoneConfirmationCode
• Код подтверждения - проверка - Website.ConfirmMobilePhone
• Код авторизации - отправка - Website.SendMobilePhoneAuthorizationCode

mobilePush.md

Описание сценария с базовыми операциями для мобильного приложения

В рамках сценария заведется

Точки контакта: 

• Android приложение - Android
• iOS приложение - iOS

Точки интеграции: 

• Android приложение {{projectName}} - {{projectName}}-Android
• Android приложение {{projectName}} - Sandbox - {{projectName}}-Android-sandbox
• iOs приложение {{projectName}} - {{projectName}}-iOs
• iOs приложение {{projectName}} - Sandbox - {{projectName}}-iOs-sandbox

Статусы позиции заказа:

• Создан - Create - Категория “Оформлена”

Шаблоны действия:

• Авторизация в ЛК в мобильном приложении

Операции:

• Каталог - просмотр продукта в мобильном приложении - Mobile.ViewProduct
• Каталог - просмотр категории в мобильном приложении - Mobile.ViewCategory
• Клиент - Авторизация в ЛК в мобильном приложении - Mobile.AuthorizeCustomer
• Клиент - Регистрация в мобильном приложении - Mobile.RegisterCustomer
• Клиент - редактирование данных в ЛК мобильного приложения - Mobile.EditCustomer
• Заказ - создание авторизованным в мобильном приложении - Mobile.CreateAuthorizedOrder
• Заказ - создание неавторизованным в мобильном приложении - Mobile.CreateUnauthorizedOrder
• Корзина - установка списка в мобильном приложении - Mobile.SetCart
• Избранное - установка списка в мобильном приложении - Mobile.SetWishList
• Избранное - добавление товара в мобильном приложении - Mobile.AddToWishList
• Избранное - убрать из списка в мобильном приложении - Mobile.RemoveFromWishList

OSMI_cards.md

Осми

https://help.mindbox.ru/docs/интеграция-osmi-cards

В рамках сценария заведется

Точка контакта: OSMICards с названием OSMI Cards

Точка интеграции: {{projectName}}OSMICards с названием OSMI Cards с дополнительными настройками:

• Во всех брендах, если есть бренды
• Подтверждение email
• Подтверждение телефонов
• Авторизация и доступ к аккаунту через мобильный телефон

Дополнительные поля:

• Клиент - Ссылка на установку электронной карты - WalletCardLink
• Клиент - Подписан на рассылки - WalletCardSubscription
• Клиент - Ссылка на qr-код установки карты - WalletCardQrCodeLink

Шаблоны действий:

• Обновление электронной карты - UpdateCard

Сегменты клиентов:

• Клиенты с картами

Операции

• Wallet.BindCard
• Wallet.CheckCustomerByMobilePhone
• Wallet.EditCustomer
• Экспорт клиентов с дисконтной картой - Wallet.ExportCustomersWithDiscountCards
• Wallet.RegisterCustomer
• Получение ссылки на электронную карту - Wallet.SetCardLink
• Wallet.SubscribeCard
• Wallet.UnsubscribeCard
• Обновление электронной карты - Wallet.UpdateCard

SR10.md

Сет ритеил 10

https://help.mindbox.ru/docs/интеграция-set-retail

В рамках сценария заведется

Точка контакта: Административный сайт

Точка интеграции: {{projectName}}-SR10 с названием {{projectName}}-SR10. Доступна во всех брендах, если есть бренды

Статусы позиции заказа:

• Оплачен на кассе - SR10Paid - Категория “Доставлена”
• Возврат - SR10Return - Категория “Возврат”

Бальный счет:

• Основной счет (Баллы доступны через 1 день, Объединение баллов при объединении клиентов, округление до ближайшего целого (математическое округление))

Операции

• Клиент - получение информации о клиенте SR10 - Offline.GetCustomerInfo
• Пречек - авторизованный SR10 - Offline.AuthorizedPreorder
• Пречек - аноним SR10 - Offline.AnonymousPreorder
• Пречек - не авторизованный SR10 - Offline.UnauthorizedPreorder
• Процессинг чека - Авторизованный SR10 - Offline.BeginAuthorizedOrderTransaction
• Процессинг чека - Аноним SR10 - Offline.BeginAnonymousOrderTransaction
• Коммит - подтверждение чека SR10 - Offline.CommitOrderTransaction
• Ролбек - откат чека SR10 - Offline.RollbackOrderTransaction
• Отложенная обработка чека SR10 - Offline.SaveOfflineOrder
• Возврат позиции заказа SR10 - Offline.Return
• Код авторизации - отправка SR10 (заводится без отправки смс с кодом авторизации) - Offline.SendMobilePhoneAuthorizationCode
• Код авторизации - проверка SR10 - Offline.CheckMobilePhoneAuthorizationCode