API starých aplikácií

Namier aplikáciu, ktorá pozná iba Sonarr alebo Radarr, na HolyArrs. Daj jej adresu končiacu na /sonarr alebo /radarr a kľúč a bude s HolyArrs zaobchádzať ako s touto aplikáciou.

Je to malé API vytvorené iba pre tieto aplikácie. Pre vlastné skripty použi API HolyArrs.

Zapnutie

Predvolene je vypnuté. Kým je vypnuté, každá adresa pod /sonarr/ a /radarr/ odpovedá 404.

1. Otvor Settings > API (nastavenia > API).
2. Na karte Requests from Seerr and Overseerr (žiadosti zo Seerr a Overseerr) zapni Answer Seerr and Overseerr (odpovedať Seerr a Overseerr).
3. Klikni na Make key (vytvoriť kľúč) vedľa Shows (seriály). Toto je kľúč pre stranu Sonarr. Skopíruj ho hneď; zobrazí sa iba raz.
4. Klikni na Make key vedľa Movies (filmy). Toto je kľúč pre stranu Radarr. Skopíruj aj ten.
5. Poznač si adresu každej strany z karty, napríklad /sonarr. Pod URL base sa ukáže /holyarrs/sonarr. Použi to, čo ukazuje karta.

Vytvorenie kľúča si vypýta tvoje heslo znova, ak je posledné prihlásenie heslom už staršie. Potom nastav každú aplikáciu: pozri Klienti API starých aplikácií.

Upozornenie

Seerr ukladá kľúče ako obyčajný text vo svojom súbore s nastaveniami. Preto je Let these apps delete files (nechať tieto aplikácie mazať súbory) predvolene vypnuté.

Nastavenia karty

Nastavenie	Čo robí	Predvolene
Answer Seerr and Overseerr	Zapína a vypína /sonarr a /radarr spolu.	Vypnuté
Make key (vytvoriť kľúč) / New key (nový kľúč)	Vytvorí kľúč pre danú stranu. Nový kľúč okamžite zastaví starý.
Remove key (odstrániť kľúč)	Vymaže kľúč danej strany. Aplikácie, ktoré ho používajú, sú odmietnuté.
Let these apps delete files	Keď je vypnuté, odstránenie titulu v aplikácii súbory zachová. Keď je zapnuté, súbory idú najprv do odkladacieho priečinka, ako pri každom mazaní v HolyArrs.	Vypnuté

Pri každom kľúči karta ukazuje jeho posledné 4 znaky, kto ho vytvoril a kedy bol naposledy použitý.

Pre expertov

Odoslanie kľúča

HolyArrs číta kľúč z prvého miesta, kde ho nájde, v tomto poradí. Zlý kľúč na skoršom mieste zlyhá, aj keď je neskorší správny.

Poradie	Miesto	Príklad
1	hodnota apikey v dotaze, ľubovoľná veľkosť písmen	/sonarr/api/v3/series?apikey=KEY
2	hlavička X-Api-Key	X-Api-Key: KEY
3	hlavička Authorization, s Bearer alebo bez	Authorization: Bearer KEY

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

Tvar s dotazom sa prijíma iba na týchto adresách a HolyArrs ho vo svojom logu skrýva. Reverse proxy pred ním môže stále logovať celú adresu.

Pravidlá kľúčov

• Každá strana má vlastný kľúč, vytvorený iba na tejto karte. Kľúče API HolyArrs (začínajú hak_) tu nefungujú a tieto kľúče nefungujú nikde inde.
• Kľúč koná ako človek, ktorý ho vytvoril, a ten potrebuje oprávnenie spravovať knižnicu. Prowlarr navyše potrebuje oprávnenie meniť nastavenia.
• Ak je ten človek vypnutý alebo oprávnenie stratí, aplikácie sú odmietnuté, kým niekto nevytvorí nový kľúč. Karta ťa na to upozorní.

Správa cez API HolyArrs

Prihlásený svojím heslom. Volania s kľúčmi vyžadujú nedávne prihlásenie heslom.

Čo	Volanie
Prečítať prepínače, adresy a kľúče	GET /api/v1/settings/old-app-api
Zapnúť	PUT /api/v1/settings/old-app-api s {"enabled": true}
Nechať aplikácie mazať súbory	PUT /api/v1/settings/old-app-api s {"delete_files": true}
Vytvoriť kľúč pre stranu Sonarr	POST /api/v1/settings/old-app-api/keys/sonarr
Vytvoriť kľúč pre stranu Radarr	POST /api/v1/settings/old-app-api/keys/radarr
Odstrániť kľúč	DELETE /api/v1/settings/old-app-api/keys/sonarr (alebo radarr)

Súvisiace stránky

• Klienti API starých aplikácií
• Limity API starých aplikácií
• Reverse proxy a URL base