Перейти к содержанию

Справочные данные

GET /enums

Отдаёт все закрытые перечисления, которые встречаются в ответах, — со значениями и подписями на двух языках.

Параметры

Нет.

Запрос

curl -H "X-API-Key: $KINODATA_KEY" \
  "https://api.kinodata.space/v1.2/enums"

Ответ

{
  "title_kinds": [
    { "value": "movie",       "label_ru": "Фильмы",       "label_en": "Movies" },
    { "value": "series",      "label_ru": "Сериалы",      "label_en": "Series" },
    { "value": "mini_series", "label_ru": "Мини-сериалы", "label_en": "Mini-series" }
  ],
  "credit_roles": [
    { "value": "director", "label_ru": "Режиссёры",  "label_en": "Directors" },
    { "value": "actor",    "label_ru": "Актёры",     "label_en": "Actors" },
    { "value": "writer",   "label_ru": "Сценаристы", "label_en": "Writers" }
  ],
  "relation_kinds": [
    { "value": "similar",       "label_ru": "Похожие",       "label_en": "Similar" },
    { "value": "related",       "label_ru": "Связанные",     "label_en": "Related" },
    { "value": "referenced_in", "label_ru": "Упоминается в", "label_en": "Referenced in" },
    { "value": "reference",     "label_ru": "Отсылки к",     "label_en": "References" }
  ]
}

Ошибки

статус код когда
401 unauthorized ключ отсутствует или недействителен

Примечания

Ответ в примере сокращён до трёх наборов; на самом деле их восемнадцать — полный список с значениями есть в справочнике схем.

Это машинный контракт: по нему генерируются типы и подписи, чтобы не зашивать их в клиент. Подписи приходят на обоих языках сразу, а не по ?lang=, — набор скачивают один раз и рисуют на любом.

Значения — те же строки, которые принимают фильтры: ?kind=mini_series, ?role=director, ?relation=referenced_in.

Набор меняется только вместе с выкладкой, поэтому ответ кэшируется на сутки и поддерживает If-None-Match.

GET /health

Проверка доступности сервиса.

Параметры

Нет. Ключ тоже не нужен — это единственный путь без авторизации.

Запрос

curl "https://api.kinodata.space/health"

Ответ

{ "status": "ok" }

Ошибки

Ответ либо 200 с телом выше, либо недоступен вовсе — тогда отвечает не сервис, а прокси перед ним.

Примечания

Путь живёт в корне, без префикса версии: мониторингу незачем знать о версиях, а адрес проверки не должен меняться.

Ответ отдаётся без кэширования, так что мониторинг видит текущее состояние, а не последнее сохранённое.