NurCore API
API Reference

API Reference

Все доступные endpoint'ы NurCore API.

API доступно по адресу https://api.nurcore.kg.

Группы

Базовый contract

  • Auth: один заголовок X-API-Key: pk_… | sk_…. Тип ключа (publishable / secret) и client_type (consumer_app / agency / kiosk) определяются автоматически по самому ключу — слать дополнительно X-Client-Id / X-Client-Type не нужно (gateway всё равно их перезапишет). См. Authentication.
  • Content-Type: application/json (UTF-8) для всех мутирующих запросов
  • Errors: {detail: string | object} с HTTP status code
  • Pagination: ?page=1&page_size=50{data, total, page, page_size, has_next, has_prev}
  • Sorting: ?sort_by=created_at&order=desc
  • Filtering: query params per resource (см. detail pages)
  • Idempotency: мутирующие запросы (POST/PUT/PATCH) могут идти с Idempotency-Key: <unique-string> — TTL 24h. См. Idempotency.

Стандартные заголовки ответа

HeaderОписание
x-request-idUUID запроса (приложите к bug-репорту)
x-ratelimit-remainingЗапросов осталось в окне
x-ratelimit-resetUnix timestamp следующего окна
SunsetЕсли endpoint deprecated — дата отключения

HTTP-коды

КодЗначение
200, 201, 204Успех
400Bad Request — нарушение бизнес-правил
401Unauthorized — нет или невалидный API Key
403Forbidden — нет прав на ресурс
404Not Found
409Conflict — race condition (например, места заняты)
410Gone — broня истекла (15 минут на оплату прошли)
422Unprocessable Entity — валидация payload
429Too Many Requests — rate limit
5xxServer error — повторите позже

См. Error handling для подробностей.

On this page