Интеграция по API¶
Техническая документация для интеграции кассовых систем и POS терминалов с API Sagi.
Быстрый старт¶
- Получите доступ: Запросите учетные данные для 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
Базовый URL¶
Тестовая среда: Тестовый код для SMS подтверждения — 1111.
Формат ответов API¶
Все эндпоинты API возвращают результат в следующем формате:
В документации эндпоинтов показано только содержимое поля data.
Технические требования¶
- HTTP/HTTPS клиент для API запросов (HTTPS обязателен)
- JSON для обмена данными
- JWT токены для аутентификации (
Authorization: Bearer {token}) - UTF-8 кодировка
- Версия API: v1 (
/api/v1/)
Лимиты запросов¶
| Категория | Лимит |
|---|---|
| Общий лимит | 1000 запросов/час на токен |
| Аутентификация | 10 попыток/час на IP |
| Поиск клиентов | 100 запросов/минуту |
| Транзакции | без ограничений |
Безопасность¶
- HTTPS обязателен — все HTTP запросы перенаправляются
- JWT токены с автоматическим обновлением
- SMS коды для подтверждения списания бонусов
- Ограничения по ролям (кассир/администратор/менеджер)