13. System

Раздел описывает служебные системные эндпоинты платформы.

13.1 Назначение раздела

Раздел System используется для:

• проверки доступности API и базы данных;
• получения текущей числовой версии API.

---

13.2 Общие правила

Авторизация

Эндпоинты раздела System не требуют авторизации.

Общие ошибки

Код	Тип	Описание
500	Internal Server Error	Необработанная ошибка сервера.
503	Service Unavailable	Сервис или база данных временно недоступны.

---

13.3 GET /health

Возвращает статус доступности API и состояние подключения к базе данных.

Эндпоинт предназначен для систем мониторинга и внешних проверок доступности.

Авторизация

• не требуется.

Response (200)

• status (string) — общее состояние API.
• database (string) — состояние базы данных.

Поддерживаемые значения:

• для status:
  • healthy
  • degraded
• для database:
  • connected
  • disconnected

Логика ответа

• если API работает и база данных доступна, сервер возвращает:
  • status = healthy
  • database = connected
• если API работает, но база данных недоступна, сервер возвращает:
  • status = degraded
  • database = disconnected

Пример запроса

GET /api/v1/health HTTP/1.1
Host: api.parktrack.live

Пример ответа (200) — база данных доступна

{
  "status": "healthy",
  "database": "connected"
}

Пример ответа (200) — база данных недоступна

{
  "status": "degraded",
  "database": "disconnected"
}

---

13.4 GET /version

Возвращает числовую версию API.

Авторизация

• не требуется.

Response (200)

• api_version (string) — числовая версия API.

Пример запроса

GET /api/v1/version HTTP/1.1
Host: api.parktrack.live

Пример ответа (200)

{
  "api_version": "1.0"
}

---