Sagi API#
Добро пожаловать в документацию интеграции Sagi (loyalty bonus system) для кассовых систем и POS терминалов.
Система Sagi предоставляет полнофункциональную API для интеграции бонусной программы лояльности, включающую:
Аутентификацию бизнес-пользователей с JWT токенами
Поиск и управление клиентами по номеру телефона
Начисление и списание бонусов с поддержкой кодов подтверждения
Систему штампов и наград для программ лояльности
Полные рабочие процессы для интеграции с POS системами
Обработку ошибок и рекомендации по отказоустойчивости
Быстрый старт#
Получите доступ: Запросите учетные данные для API у команды Sagi
Авторизуйтесь: Используйте
/api/v1/auth/businessдля получения JWT токенаНастройте филиал: Получите
branch_idиgroup_idдля работы с бонусамиИнтегрируйте: Следуйте пошаговым сценариям работы в разделе «Рабочие процессы»
Swagger API#
Для интерактивного тестирования API используйте Swagger UI:
https://gateway.sagi.kz/api/v1/swagger/index.html
Swagger предоставляет полную OpenAPI спецификацию со всеми эндпоинтами, параметрами и возможностью выполнить запросы прямо в браузере.
Содержание
- Обзор системы
- Аутентификация
- API эндпоинты
- Базовый URL
- ВАЖНОЕ ПРИМЕЧАНИЕ
- 1. Поиск клиента
- 2. Редактирование личных данных клиента
- 3. Получение баланса клиента в филиале
- 4. Получение информации о частном филиале клиента
- 5. Получение процента кешбека клиента
- 6. Получение информации о штампах клиента
- 7. Выдача награды клиенту
- 8. Создание транзакции для начисления бонусов
- 9. Завершение транзакции и начисление бонусов
- 10. Отправка кода подтверждения для списания бонусов
- 11. Отмена транзакции
- 12. Частичный возврат
- 13. Обновление токена авторизации
- Сущности системы
- Рабочие процессы
- Первоначальная настройка (выполняется один раз)
- Сценарий 1: Начисление бонусов (без списания)
- Сценарий 2: Списание бонусов с кодом подтверждения
- Сценарий 3: Выдача награды
- Сценарий 4: Обработка ошибок
- Сценарий 5: Отмена и возвраты
- Особенности реализации
- Сценарий 6: Управление токенами авторизации
- Сценарий 7: Работа с процентами кешбека
- Обработка ошибок