Руководство по интеграции с POS-системой

Обзор

Это руководство описывает процесс интеграции функционала кэшбэка AOS с POS-системами магазинов. Включает аутентификацию, сканирование QR-кодов, отправку транзакций и начисление бонусов.

🔁 Процесс Интеграции

Ниже приведен пошаговый процесс интеграции POS-системы с AOS:

1. Регистрация магазина

Каждый филиал добавляется в систему AOS, ему присваивается уникальный токен.

2. Использование токенов

Токены передаются во всех API-запросах для идентификации филиала.

3. Пользователь должен быть авторизован

Пользователь должен установить приложение AOS и войти в него.

4. Сканирование QR-кода на кассе

Кассир сканирует QR-код клиента через POS-терминал.

5. Получение данных клиента

QR-код отправляется через API, и возвращаются данные профиля клиента.

6. Ввод данных чека

Кассир вводит информацию о товарах и способах оплаты.

7. Использование бонусов (если нужно)

Предусматривается окно ввода суммы кэшбэка, которую хочет использовать клиент.

8. Отправка транзакции

Все данные отправляются на сервер AOS.

9. Обработка ответа

Если получен успешный ответ, чек закрывается и печатается.

10. Обновление баланса клиента

Бонус начисляется или списывается, данные обновляются в приложении.

🖲️ Требования к POS-системе

Для успешной интеграции POS-программа должна поддерживать следующие компоненты:

Кнопка сканирования QR + модальное окно

Для сканирования QR-кода AOS.

Отображение информации о клиенте

Имя клиента и баланс кэшбэка должны отображаться после сканирования.

Интерфейс использования бонусов

Кнопка и окно для ввода суммы списания бонуса.

Печать скидки на чеке

Если бонус использован, показать его как скидку на бумажном чеке.

📡 API Эндпоинты

1. Получить данные клиента

Query-параметры:

Этот эндпоинт получает данные клиента на основе отсканированного QR-кода и проверяет их с указанным токеном магазина.

2. Отправить транзакцию

Структура тела запроса:

{
 "rTime": "string",
 "rDate": "string",
 "filial": "string",
 "client": "string",
 "cEmployee": "string",
 "rNumber": "string",
 "rTotal": 0,
 "bonus": 0,
 "items": [
   {
     "discount": 0,
     "price": 0,
     "barcode": "string",
     "amount": 0,
     "vatPercent": 0,
     "vat": 0,
     "name": "string",
     "classCode": "string",
     "other": 0,
     "commissionTIN": "string"
   }
 ],
 "payments": [
   {
     "item": "Наличные",
     "total": 150000.2
   }
 ],
 "cardType": "static",
 "percent": 0
}

Примечания:

• bonus: Сумма кэшбэка, используемая клиентом (если есть).
• rTotal: Общая сумма чека до применения кэшбэка.
• payments: Может включать наличные, карту или другие способы оплаты.

✅ Заключительные замечания

• Необходимо корректно указывать НДС и комиссии для соблюдения фискальных требований.
• Ответы API должны обрабатываться корректно с валидацией на стороне POS.
• Обратная связь для клиента (например, заработанный бонус) должна отображаться в реальном времени для прозрачности.

Для технической поддержки или вопросов обращайтесь к команде разработки AOS.