Preskoči na sadržaj

API za dosadašnje aplikacije

Napredno

Usmjeri aplikaciju koja poznaje samo Sonarr ili Radarr na HolyArrs. Daj joj adresu koja završava s /sonarr ili /radarr i ključ, pa će ona HolyArrs smatrati tom aplikacijom.

Ovo je mali API napravljen samo za te aplikacije. Za vlastite skripte koristi HolyArrs API.

Prema zadanim postavkama je isključen. Dok je isključen, svaka adresa pod /sonarr/ i /radarr/ odgovara s 404.

  1. Otvori Settings > API (postavke > API).
  2. Na kartici Requests from Seerr and Overseerr (zahtjevi iz Seerra i Overseerra) uključi Answer Seerr and Overseerr (odgovaraj Seerru i Overseerru).
  3. Klikni na Make key (napravi ključ) pored Shows (serije). To je ključ za Sonarr. Kopiraj ga odmah; prikazuje se samo jednom.
  4. Klikni na Make key pored Movies (filmovi). To je ključ za Radarr. Kopiraj i njega.
  5. Zabilježi adresu za svaku stranu na kartici, na primjer /sonarr. Uz URL base prikazuje /holyarrs/sonarr. Koristi ono što kartica prikazuje.

Pri izradi ključa ponovno se traži tvoja lozinka ako zadnja prijava njome nije bila nedavno. Zatim postavi svaku aplikaciju: vidi Klijenti API-ja za dosadašnje aplikacije.

Postavka Što radi Zadano
Answer Seerr and Overseerr Zajedno uključuje ili isključuje /sonarr i /radarr. Isključeno
Make key / New key Pravi ključ za tu stranu. Novi ključ odmah zaustavlja stari.
Remove key Briše ključ te strane. HolyArrs odbija aplikacije koje ga koriste.
Let these apps delete files Kad je isključeno, uklanjanje naslova u aplikaciji ostavlja datoteke. Kad je uključeno, datoteke najprije idu u mapu za zadržavanje, kao pri svakom brisanju u HolyArrs. Isključeno

Za svaki ključ kartica prikazuje zadnja 4 znaka, tko ga je napravio i kad je zadnji put korišten.

Slanje ključa

HolyArrs čita ključ s prvog mjesta na kojem ga nađe, ovim redom. Pogrešan ključ na ranijem mjestu ne prolazi, čak i ako je kasniji ispravan.

Redoslijed Mjesto Primjer
1 vrijednost upita apikey, bilo koja veličina slova /sonarr/api/v3/series?apikey=KEY
2 zaglavlje X-Api-Key X-Api-Key: KEY
3 zaglavlje Authorization, sa ili bez Bearer Authorization: Bearer KEY
Terminal window
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

Oblik s upitom prihvaća se samo na ovim adresama, a HolyArrs ga skriva u vlastitom logu. Reverse proxy ispred možda ipak bilježi cijelu adresu.

Pravila za ključeve
  • Svaka strana ima svoj ključ, napravljen samo na ovoj kartici. HolyArrs API ključevi (koji počinju s hak_) ovdje ne rade, a ovi ključevi ne rade nigdje drugdje.
  • Ključ djeluje kao osoba koja ga je napravila, a ona mora imati dozvolu za upravljanje Bibliotekom. Prowlarr treba i dozvolu za mijenjanje postavki.
  • Ako je ta osoba isključena ili izgubi dozvolu, HolyArrs odbija aplikacije dok netko ne napravi novi ključ. Kartica te upozorava.
Upravljanje preko HolyArrs API-ja

Prijavljen si lozinkom. Pozivi za ključeve traže nedavnu prijavu lozinkom.

Što Poziv
Pročitaj prekidače, adrese i ključeve GET /api/v1/settings/old-app-api
Uključi PUT /api/v1/settings/old-app-api s {"enabled": true}
Dopusti aplikacijama brisanje datoteka PUT /api/v1/settings/old-app-api s {"delete_files": true}
Napravi ključ za Sonarr POST /api/v1/settings/old-app-api/keys/sonarr
Napravi ključ za Radarr POST /api/v1/settings/old-app-api/keys/radarr
Ukloni ključ DELETE /api/v1/settings/old-app-api/keys/sonarr (ili radarr)

HolyArrs je besplatan. Ako ti je uštedio vrijeme, daj mu zvjezdicu na GitHubu, podrži ga ili počasti me kavom.