API Reference
СПРАВОЧНИК API
Справочник API
Публичный REST-контракт Suward Gateway V2. 59 эндпоинтов, OpenAPI 3.1.
Справочник генерируется из swagger.json (OpenAPI 3.1), который собирается из Go-аннотаций в gateway-v2.
Аутентификация
Схемы ниже — точно те, что в swagger securitySchemes.
| Scheme | Where | Purpose |
|---|---|---|
| accessToken | cookie accessToken (HttpOnly) | Браузерная сессия (дашборд) |
| refreshToken | cookie refreshToken (HttpOnly) | Обновление сессии |
| X-Api-Key | header X-Api-Key | Server-to-server интеграция мерчанта |
Формат Bearer / sk_* не объявлен в swagger и не документируется как факт до подтверждения в коде gateway.
Сквозные правила
Идемпотентность
Через externalId на платеже (дедуп заказа). Заголовка Idempotency-Key нет.
Rate-limit
API-ключи v2 имеют rate-limit. См. API-ключи.
Пагинация
ListPayments — cursor-пагинация по last_id.
Деньги
Все денежные поля — строки, не float.
Ошибки
Стандартные форматы ошибок из swagger error-схем.
Группы эндпоинтов
Переходите в каждую группу ресурсов: эндпоинты, схемы запросов, заметки.