Přeskočit na obsah

API pro dřívější aplikace

Pokročilý

Namiř na HolyArrs aplikaci, která zná jen Sonarr nebo Radarr. Dej jí adresu končící /sonarr nebo /radarr a klíč a bude s HolyArrs zacházet jako s tou aplikací.

Je to malé API určené jen pro tyto aplikace. Pro vlastní skripty používej API HolyArrs.

Ve výchozím stavu je vypnuté. Dokud je vypnuté, každá adresa pod /sonarr/ a /radarr/ odpovídá 404.

  1. Otevři Settings > API (nastavení > API).
  2. Na kartě Requests from Seerr and Overseerr (žádosti ze Seerru a Overseerru) zapni Answer Seerr and Overseerr (odpovídat Seerru a Overseerru).
  3. Klikni na Make key (vytvořit klíč) u Shows (seriály). Je to klíč strany Sonarr. Zkopíruj si ho hned; zobrazí se jen jednou.
  4. Klikni na Make key u Movies (filmy). Je to klíč strany Radarr. Zkopíruj i ten.
  5. Poznamenej si adresu každé strany z karty, například /sonarr. Pod URL base se zobrazí /holyarrs/sonarr. Použij to, co ukazuje karta.

Vytvoření klíče vyžaduje znovu tvoje heslo, pokud ses s ním nedávno nepřihlásil. Pak nastav každou aplikaci: viz Klienti API pro dřívější aplikace.

Nastavení na kartě

Odkaz na Nastavení na kartě
Nastavení Co dělá Výchozí
Answer Seerr and Overseerr Zapne nebo vypne /sonarr a /radarr společně. Vypnuto
Make key / New key (nový klíč) Vytvoří klíč pro danou stranu. Nový klíč okamžitě zastaví starý.
Remove key (odebrat klíč) Smaže klíč dané strany. Aplikace, které ho používají, jsou odmítnuty.
Let these apps delete files Když je vypnuté, odebrání titulu v aplikaci nechá soubory. Když je zapnuté, soubory nejdřív přejdou do přechodné složky, jako při každém mazání v HolyArrs. Vypnuto

U každého klíče karta ukazuje jeho poslední 4 znaky, kdo ho vytvořil a kdy byl naposledy použit.

Posílání klíče

HolyArrs čte klíč z prvního místa, kde ho najde, v tomto pořadí. Špatný klíč na dřívějším místě selže, i když je pozdější správný.

Pořadí Místo Příklad
1 hodnota dotazu apikey, na velikosti písmen nezáleží /sonarr/api/v3/series?apikey=KEY
2 hlavička X-Api-Key X-Api-Key: KEY
3 hlavička Authorization, s Bearer nebo bez Authorization: Bearer KEY
Terminal window
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

Tvar s dotazem se přijímá jen na těchto adresách a HolyArrs ho ve svém logu skrývá. Reverzní proxy před ním ale může celou adresu logovat dál.

Pravidla pro klíče
  • Každá strana má vlastní klíč, vytvořený jen na této kartě. Klíče API HolyArrs (začínající hak_) tady nefungují a tyto klíče nefungují nikde jinde.
  • Klíč jedná jménem toho, kdo ho vytvořil, a ten člověk potřebuje oprávnění spravovat Knihovnu. Prowlarr navíc potřebuje oprávnění měnit nastavení.
  • Když je ten člověk vypnutý nebo o oprávnění přijde, aplikace jsou odmítány, dokud někdo nevytvoří nový klíč. Karta tě na to upozorní.
Správa přes API HolyArrs

Přihlas se heslem. Volání s klíči vyžadují nedávné přihlášení heslem.

Co Volání
Přečíst přepínače, adresy a klíče GET /api/v1/settings/old-app-api
Zapnout PUT /api/v1/settings/old-app-api s {"enabled": true}
Nechat aplikace mazat soubory PUT /api/v1/settings/old-app-api s {"delete_files": true}
Vytvořit klíč strany Sonarr POST /api/v1/settings/old-app-api/keys/sonarr
Vytvořit klíč strany Radarr POST /api/v1/settings/old-app-api/keys/radarr
Odebrat klíč DELETE /api/v1/settings/old-app-api/keys/sonarr (nebo radarr)

HolyArrs je zdarma. Pokud ti ušetřil čas, dej mu hvězdičku na GitHubu, podpoř ho sponzorstvím nebo kup mi kávu.