Описание работы с POS

Url для обращения к методам API: домен/api/1/

Модуль используется для начисления и списания баллов, выдачи подарков, активации акций и т.д. Все действия требуют указания номера телефона клиента. Есть два способа его получения: сканирование qr-кода или ручной поиск клиента по номеру. Параметры, зашифрованные в qr-коде, описаны отдельно для каждого метода. В случае с ручным поиском клиент диктует номер телефона сотруднику.

Получение параметров из qr-кода

В qr-коде, который клиент показывает сотруднику, зашифрован json-объект, который содержит действие operation, которое необходимо совершить, и параметры, которые нужно передать в метод API. Возможные значения поля operation с пояснениями приведены ниже. Примеры других параметров приведены для каждого метода отдельно.

Получение параметров вручную

Клиент может не показывать qr-код, а просто продиктовать номер телефона. Это возможно только для начисления баллов и выдачи подарка, для активации акций необходим qr-код. Порядок действий будет следующим:

1. Клиент диктует номер телефона сотруднику, сотрудник вводит номер телефона в терминале
2. Вызывается метод findClient для проверки. Метод вернет данные клиента, и сотрудник может убедиться, что номер введен верно. Кроме того, будет известно количество баллов у клиента
3. Если необходимо начислить баллы, вызывается метод charge
4. Если необходимо выдать подарок, вызывается метод getPresents для получения списка всех доступных подарков. У каждого подарка будет известна стоимость в баллах, т.е. сотрудник может понять, какие подарки доступны клиенту (кроме того, вы можете установить доступность подарков программно). После выбора подарка вызывается метод give