External Loyalty (Order External Data)

Нужна, когда требуется простейшая интеграция, которая не предусматривает какого-то глубокого прямого взаимодействия iikoWaiter и системы лояльности.

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

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

При такой интеграции, если номер карты не существует в базе гостей БРД, то гость с такой картой будет создан автоматически с названием в формате Карта № NNNNNNN.

Отсканированное значение кладется в externalData по ключу: "arbus.iikowaiter.checkinscannedvalue"

Доступ к сохранённым PaymentItems в ExternalData

Content-Type	application/json

Content-Type	application/json
ExternalData key	iikowaiter5.paymentItems
API Method	PluginContext.Operations.TryGetOrderExternalDataByKey(orderId, Key)
Версия плагина iikoWaiter5	7.8.3+

DTO

Property	Type	Description

Property	Type	Description
PaymentItems	List<PaymentItem>	Список всех добавленных к заказу PaymentItems.

PaymentItem

Property	Type	Description

Property	Type	Description
PaymentType	PaymentType	Тип платёжной системы.
Sum	decimal	Сумма платежа.

PaymentType

Property	Type	Description

Property	Type	Description
Id	Guid	Id платежной системы
Kind	PaymentTypeKind (enum)
Name	string	Имя платёжной системы.

PaymentTypeKind (enum)

    Unknown = 0,
    Cash = 1,
    BankCard = 2,
    IikoCard5Bonus = 3,
    IikoCard5Deposit = 4,
    ExternalLoyaltyBonus = 5,
    ExternalLoyaltyDeposit = 6

Со стороны системы лояльности интеграция с iikoFronte реализуется в виде фронтового плагина.

Основывается на возможностях iikoFrontAPI v5+.

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

Тогда сценарий такой:

iikoWaiter читает wallet карту и сохраняет ее номер в ExternalData по ключу:
"arbus.iikowaiter.checkinscannedvalue"
Плагин лояльности, например, при выборе своего настроенного внешнего типа оплаты (или по событиям печати пречека или перехода на страницу оплаты) читает эти данные и работает с ними, не требуя ручного ввода или повторного считывания карты.
Также iikoWaiter (на уровне плагина) делает привязку в заказ гостя БРД по номеру карты (так как нам все же нужно на мобилку получить ответ на запросы взаимодействия с лояльностью). Если в базе РМС гостя с нужным номером карты нет, то плагин iikowaiter ее создает со следующими значениями полей:
name = “Карта № NNNNNN”, где NNNNNN берется из значения checkinscannedvalue CardNumber = 'NNNNNN' Телефон ='NNNNNN'