API прежних приложений

Направьте на HolyArrs приложение, которое знает только Sonarr или Radarr. Дайте ему адрес, который кончается на /sonarr или /radarr, и ключ, и оно будет считать HolyArrs этим приложением.

Это небольшой API, сделанный только для таких приложений. Для своих скриптов используйте API HolyArrs.

Как включить

По умолчанию он выключен. Пока он выключен, любой адрес под /sonarr/ и /radarr/ отвечает 404.

1. Откройте Settings > API (Настройки > API).
2. На карточке Requests from Seerr and Overseerr (запросы от Seerr и Overseerr) включите Answer Seerr and Overseerr (отвечать Seerr и Overseerr).
3. Нажмите Make key (создать ключ) рядом с Shows (сериалы). Это ключ стороны Sonarr. Скопируйте его сразу: он показывается один раз.
4. Нажмите Make key рядом с Movies (фильмы). Это ключ стороны Radarr. Скопируйте и его.
5. Запишите адрес каждой стороны с карточки, например /sonarr. Если задан URL base, там будет /holyarrs/sonarr. Используйте то, что показывает карточка.

Если вы давно не входили с паролем, при создании ключа HolyArrs снова спросит пароль. Затем настройте каждое приложение: см. Клиенты API прежних приложений.

Осторожно

Seerr хранит ключи открытым текстом в своём файле настроек. Поэтому Let these apps delete files (разрешить этим приложениям удалять файлы) по умолчанию выключена.

Настройки карточки

Настройка	Что делает	По умолчанию
Answer Seerr and Overseerr	Включает или выключает /sonarr и /radarr вместе.	Выключена
Make key / New key (новый ключ)	Создаёт ключ для этой стороны. С новым ключом старый сразу перестаёт работать.
Remove key (удалить ключ)	Удаляет ключ этой стороны. Приложения с этим ключом получают отказ.
Let these apps delete files	Когда выключена, при удалении тайтла в приложении файлы остаются. Когда включена, файлы сначала попадают в папку временного хранения, как при любом удалении в HolyArrs.	Выключена

Для каждого ключа карточка показывает его последние 4 символа, кто его создал и когда им пользовались в последний раз.

Для опытных

Как передать ключ

HolyArrs читает ключ из первого места, где его находит, в таком порядке. Неверный ключ в более раннем месте даёт ошибку, даже если в более позднем ключ верный.

Порядок	Место	Пример
1	Значение apikey в строке запроса, в любом регистре	/sonarr/api/v3/series?apikey=KEY
2	Заголовок X-Api-Key	X-Api-Key: KEY
3	Заголовок Authorization, с Bearer или без	Authorization: Bearer KEY

curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

Ключ в строке запроса принимается только на этих адресах, и в своём журнале HolyArrs его скрывает. Обратный прокси перед HolyArrs всё равно может записать полный адрес в свой журнал.

Правила для ключей

• У каждой стороны свой ключ, и создаётся он только на этой карточке. Ключи API HolyArrs (начинаются с hak_) здесь не работают, а эти ключи не работают больше нигде.
• Ключ действует от имени того, кто его создал, и этому человеку нужно право управлять Медиатекой. Prowlarr к тому же нужно право менять настройки.
• Если этого человека отключат или он потеряет это право, приложения будут получать отказ, пока кто-нибудь не создаст новый ключ. Карточка вас об этом предупредит.

Управление через API HolyArrs

Нужен вход с паролем. Для вызовов с ключами вход с паролем должен быть недавним.

Что	Вызов
Прочитать переключатели, адреса и ключи	GET /api/v1/settings/old-app-api
Включить	PUT /api/v1/settings/old-app-api с {"enabled": true}
Разрешить приложениям удалять файлы	PUT /api/v1/settings/old-app-api с {"delete_files": true}
Создать ключ стороны Sonarr	POST /api/v1/settings/old-app-api/keys/sonarr
Создать ключ стороны Radarr	POST /api/v1/settings/old-app-api/keys/radarr
Удалить ключ	DELETE /api/v1/settings/old-app-api/keys/sonarr (или radarr)

См. также

• Клиенты API прежних приложений
• Ограничения API прежних приложений
• Обратный прокси и URL base