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. Ползвай това, което показва картата.

Ако не си влизал с парола наскоро, за направата на ключ ще те попита за паролата отново. После настрой всяко приложение: виж Клиенти на API за по-старите приложения.

Caution

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 в адреса (query), с произволни главни и малки букви	/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 я скрива в собствения си дневник. Reverse proxy пред него може пак да записва целия адрес.

Правила за ключовете

• Всяка страна има свой ключ, който се прави само на тази карта. Ключовете за 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 за по-старите приложения
• Reverse proxy и URL base