Skip to content

overview.mdx

Latest commit

 

History

History
85 lines (65 loc) · 3.73 KB

overview.mdx

File metadata and controls

85 lines (65 loc) · 3.73 KB
Raw
title JacRed API: обзор и аутентификация
sidebarTitle Обзор
description JacRed предоставляет четыре поисковых API (Jackett JSON, Torznab XML, Prowlarr и Native JSON) и управляющие эндпоинты. Базовый URL: http://HOST:9117.
keywords
JacRed API
Jackett API
Torznab
Prowlarr
Native JSON
apikey

JacRed предоставляет несколько API для поиска торрентов и управления сервисом. Все они работают на одном порту (по умолчанию 9117) и обращаются к одному FileDB-индексу.

Базовый URL

http://YOUR_HOST:9117

Поисковые API

`GET /api/v2.0/indexers/{status}/results` — совместим с Lampa, Stremio и другими Jackett-клиентами. `GET /torznab/api` — стандарт Torznab для Sonarr, Radarr и Prowlarr. `GET /api/v1.0/torrents` — расширенный API с полями ffprobe и languages. `GET /api/v1/search` — поисковая лента Prowlarr. Newznab также доступен по `/api/v1/indexer/{id}/newznab`.

Управляющие API

Группа Эндпоинты
Config API GET/POST /api/v1.0/config*
Stats API GET /stats/torrents, /stats/tracks, /stats/meta
Sync API GET /sync/fdb/torrents, /sync/conf
Cron API GET /cron/{slug}/{action}, GET /cron/maintenance/ResumeParseAll, GET /jsondb/save
Health API GET /health, /health/background-jobs, /version, /lastupdatedb, /api/v1.0/conf
Dev API GET /dev/* — сервисные операции над FileDB и Tracks

Аутентификация

Ключ Параметр Заголовок Защищает
apikey ?apikey= X-Api-Key Поисковые эндпоинты
devkey ?devkey= X-Dev-Key Конфиг, cron, dev (из интернета)

Коды ответов

Код Значение
200 Успех
401 Неверный или отсутствующий apikey
403 Требуется devkey или LAN
404 Эндпоинт отключён в конфигурации

Служебные и системные эндпоинты

Путь Описание
GET /health Проверка живости ({status: "OK"})
GET /version Версия, git SHA, ветка, дата сборки
GET /lastupdatedb Время последнего обновления FileDB
GET /health/background-jobs Активные задачи парсинга
GET /jsondb/save Принудительный сброс FileDB на диск
GET /opensearch.xml OpenSearch-описание для браузера

OpenAPI и Swagger

curl http://localhost:9117/openapi.yaml
curl http://localhost:9117/swagger/v1/swagger.json

Swagger UI доступен по адресу http://YOUR_HOST:9117/swagger. Пересоберите клиентский код из спецификации:

cd web && npm run gen:api