Справочник API
Базовый URL: https://gateway.ticket.kg
Все методы /api/v1/* требуют заголовок X-API-Key (см. Авторизация).
Каталог
| Метод | Путь | Описание | Кэш |
|---|---|---|---|
| GET | /api/v1/categories | Активные категории | до 10 мин |
| GET | /api/v1/events | Мероприятия в продаже | до 10 мин |
| GET | /api/v1/events/{eventID} | Одно мероприятие | до 10 мин |
| GET | /api/v1/events/{eventID}/items | Сеансы мероприятия | нет |
| GET | /api/v1/event-items/{eventItemID}/seats | Схема зала, места, зоны, цены | нет |
Заказы
| Метод | Путь | Описание |
|---|---|---|
| POST | /api/v1/orders | Забронировать билеты |
| GET | /api/v1/orders/{orderID} | Заказ по ID |
| GET | /api/v1/orders?partner_order_id= | Заказ по номеру партнёра |
| POST | /api/v1/orders/{orderID}/confirm | Подтвердить продажу, получить PIN |
| DELETE | /api/v1/orders/{orderID} | Снять неоплаченную бронь |
| POST | /api/v1/orders/{orderID}/refund | Вернуть оплаченные билеты |
Отчёты
| Метод | Путь | Описание |
|---|---|---|
| GET | /api/v1/reports/sales | Отчёт о продажах за период |
Служебные
| Метод | Путь | Описание | Авторизация |
|---|---|---|---|
| GET | /health | Процесс жив | нет |
| GET | /ready | Сервис готов принимать запросы | нет |
Заголовки
| Заголовок | Направление | Описание |
|---|---|---|
X-API-Key | запрос | API-ключ партнёра. Обязателен для /api/v1/* |
Content-Type: application/json | запрос | Для запросов с телом |
X-Request-ID | запрос и ответ | ID запроса для поддержки. Если не передан, генерируется |
X-Cache: HIT | ответ | Ответ отдан из кэша каталога |
Модели всех объектов описаны на странице Модели данных.