Сценарии интеграции с использованием API

Рекомендации по прямой интеграции через REST-протокол

• Сценарии интеграции

Сценарии интеграции

Что здесь описано?

Документ описывает основные сценарии взаимодействия Кассового ПО и Сервиса лояльности. В нем собраны рекомендации о последовательности вызовов методов API сервиса лояльности. Под сценарием понимается рекомендуемая последовательность запросов к сервису И логики работы Кассового ПО, для получения определенного результата(например, продажа, возврат, начисление бонусов при продаже, выдача подарков и т.д.).

Чего здесь нет?

Документ НЕ содержит спецификацию запросов API, для ознакомления со спецификацией можно обратиться сюда:

• API сервиса лояльности(GoogleDoc)
• API сервиса лояльности(Swagger)

Общие положения

• Сценарии приведенные носят рекомендательный характер, отклонения от сценариев допустимо, если этого требует логика работы Кассового ПО
• Любой вызов защищенного метода требует наличие токена доступа.
• Кассовое ПО должно обеспечить хранение актуального токена доступа и проверку его актуальности.

Аутентификация

Перед исполнением защищенных запросов Кассовое ПО выполняет сценарий аутентификации пользователя.

Идентификация участника программы лояльности

Идентификация участника происходит может происходить в любой момент до закрытия документа. Однако, если планируется использовать скидки применяемые с учетом атрибутов карты или профиля клиента, после идентификации нужно пересчитать скидки и применить их к документу.

Идентификация может выполняться по разным фильтрам: - "by_phone" - "by_email" - "by_barcode" - "by_code" - "by_name"

Фильтры применяются к атрибутам карты по полному соответствию

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

Расчет скидок

• Расчет скидок может осуществляться интерактивно или по требованию.
• Расчет по требованию позволяет отразить актуальное состояние скидок на момент последнего вызова функции расчета и применения скидок
• Интерактивный расчет позволяет синхронизировать состояние кассы с примененными скидками "на лету"

Применение скидок

Процесс применения скидок можно поделить на несколько этапов:

Применение суммовых и процентных скидок

• Соответствие между строками в ответе сервиса и корзине документа устанавливается Кассовым ПО путем передачи поля line_number. Таким образом один и тот же товар может передаваться разными строками
• Кассовое ПО ищет в ответе строки соответствующие строкам корзины и применяет рассчитанные скидки.

Выдача подарков

• Необязательный сценарий, если не планируется выдавать подарки, сценарий можно опустить.
• Логика выдачи подарков определяется Кассовым ПО, сервис просто сообщает о необходимости выдать подарок и список подарков.

Оплата баллами

• После расчета скидок можно определить доступную для оплаты баллами сумму
• После ввода оплаты баллами требуется перерасчет скидок, т.к. могут существовать условия понижающие допустимую сумму оплаты баллами
• Метод расчета скидок с переданной суммой оплаты бонусами, автоматически пересчитает и понизит сумму оплаты бонусами, останется только применить её к чеку

Фиксация факта продажи

• Перед пробитием чека на ККТ кассовое ПО должно отразить продажу в сервисе лояльности
• Перед фиксацией продажи необходимо рассчитать и применить все суммовые скидки
• Начисление и списание бонусов согласно настроенным правилам выполняется сервисом автоматически во время фиксации продажи
• Операцию нельзя отметить, поэтому обязательно нужно пересчитать скидки перед попыткой зафиксировать продажу

Использование сертификатов

• Для использования покупателем сертификат требует предварительной реализации
• Гашение сертификата происходит в момент фиксации продажи с указанием оплаты этим сертификатом

Продажа сертификата

• Реализация сертификатов выполняется с помощью процесса продажи, как продажа обычного товара
• При фиксации продажи передается специальный объект cert_sales, содержащий массив продаваемых сертификатов

Оплата сертификатом

• Клиентское приложение должно проверить возможность гашения сертификата введенной пользователем суммой

Использование промокодов

• Промокоды не требуют реализации покупателю, номера промокодов распространяются маркетинговыми средствами
• Промокод передается в чеке при фиксации продажи и при расчете скидок (см. процессы продажи и расчета скидок)