Модуль PriorityApi является универсальным интерфейсом для интеграции с системами лояльности, поддерживает применение дисконтных и бонусных воздействий.
При отсутствии связи с сервером отправка сообщений об операциях будет осуществляться через очередь Artix-Queue.
Конфигурирование модуля
Активация модуля PriorityApi определяется параметром priorityapi
, который задается в конфигурационном файле /linuxcash/cash/conf/ncash.ini.d/priorityapi.ini
в секции [plugins]
.
Наименование | Тип данных | Возможные значения | Описание | Примечания |
---|---|---|---|---|
priorityapi | строковый |
| Активация модуля PriorityApi | По умолчанию off |
[plugins] ; Включение и выключение плагина PriorityApi ; по умолчанию off ;priorityapi=off
Настройка плагина PriorityApi производится в конфигурационном файле /linuxcash
/cash/conf/ncash.ini.d/priorityapi.ini
в секции [PriorityApi]
.
Плагин PriorityApi будет обрабатывать карты лояльности с типом cardMode
из настроек. PriorityApi не будет работать, если на кассе уже настроена лояльность с типом, указанным в cardMode
.
Наименование | Тип данных | Описание | Примечания |
---|---|---|---|
cardMode | строковый | Тип карты из группы карт, использующий PriorityApi | По умолчанию 254 |
host | строковый | Адрес сервера | По умолчанию http://localhost |
port | целочисленный | Порт сервера | По умолчанию 80 |
password | строковый | Пароль для доступа к серверу | По умолчанию не задан |
organization | строковый | Идентификатор организации | По умолчанию не задан |
businessUnit | строковый | Идентификатор магазина | По умолчанию не задан |
workPlace | строковый | Идентификатор рабочего места | По умолчанию не задан |
[PriorityApi] ; Тип карты из группы карт, использующий PriorityApi ; по умолчанию 254 ;cardMode = 254 ; Адрес сервера ; по умолчанию http://localhost ;host = http://localhost ; Порт ; по умолчанию 80 ;port = 80 ; Пароль для доступа к серверу ; По умолчанию не задан ;password = "" ; Идентификатор организации ; По умолчанию не задан ;organization = "" ; Идентификатор магазина ; По умолчаню не задан ;businessUnit = "" ; Идентификатор рабочего места ; По умолчаню не задан ;workPlace = ""
Слип лояльности, который печатается после закрытия чека, сохраняется в упрощенном виде (текст без форматирования) в БД Documents
таблицу Document
поле rtext
.
Добавление карты по номеру телефона
При использовании системы лояльности PriorityApi возможно добавление карты по номеру телефона. Для этого необходимо:
- Включить способ ввода "Удаленно" для группы карт (БД
Dictionaries
таблицаCardgroup
полеinputmask
= 16). Для группы карт указать:
маску допустимых номеров карт:
^\+7([0-9]{10})|^7([0-9]{10})|^8([0-9]{10})|(^9[0-9]{9})
правило преобразования:
+7\1\2\3\4
- тип карты соответствующий значению настройки плагина
cardMode
.
- Для правила поиска карт установить значение "По номеру карты".
- Настроить клавишу "Добавить карту" с командой
COMMAND_CARD
и параметрами:cardNumberType
со значением 1;cardMode
со значением из настроек плагина.
При использовании команды на экран будет выведен диалог для ввода номера телефона. После ввода номера телефона производится поиск карты на сервере системы лояльности. Если карта найдена, то она будет добавлена в чек.
Карта не может быть добавлена в чек, если:
- введенный номер телефона отсутствует на сервере системы лояльности;
- отсутствует связь с сервером.
Если при добавлении карты по номеру телефона не найден аккаунт, а на сервере лояльности предусмотрена регистрация клиента, то на экран будет выведен диалог:
Подтвердите операцию для создания аккаунта. Потребуется ввод кода подтверждения. После регистрации аккаунта карта добавится в чек.
В случае отказа от операции карта не будет добавлена в чек.
Если на сервере лояльности настроена верификация карты по СМС, то при добавлении карты в чек или при оплате баллами на экран будет выведен диалог: