API dotychczasowych aplikacji

Skieruj aplikację, która zna tylko Sonarr albo Radarr, na HolyArrs. Podaj jej adres kończący się na /sonarr lub /radarr oraz klucz, a będzie traktować HolyArrs jak tamtą aplikację.

To małe API stworzone wyłącznie dla takich aplikacji. Do własnych skryptów użyj API HolyArrs.

Włącz je

Domyślnie jest wyłączone. Gdy jest wyłączone, każdy adres pod /sonarr/ i /radarr/ odpowiada błędem 404.

1. Otwórz Settings > API (ustawienia > API).
2. Na karcie Requests from Seerr and Overseerr (prośby z Seerr i Overseerr) włącz Answer Seerr and Overseerr (odpowiadaj Seerr i Overseerr).
3. Kliknij Make key (utwórz klucz) obok Shows (seriale). To klucz po stronie Sonarr. Skopiuj go teraz; pokazuje się tylko raz.
4. Kliknij Make key obok Movies (filmy). To klucz po stronie Radarr. Jego też skopiuj.
5. Zanotuj adres każdej strony z karty, na przykład /sonarr. Przy URL base pokazuje się /holyarrs/sonarr. Użyj tego, co pokazuje karta.

Utworzenie klucza wymaga ponownego podania hasła, jeśli nie zalogowano się nim niedawno. Potem skonfiguruj każdą aplikację: zobacz Klienty API dotychczasowych aplikacji.

Uwaga

Seerr zapisuje klucze jawnym tekstem w swoim pliku ustawień. Dlatego Let these apps delete files jest domyślnie wyłączone.

Ustawienia na karcie

Ustawienie	Co robi	Domyślnie
Answer Seerr and Overseerr	Włącza lub wyłącza /sonarr i /radarr razem.	Wyłączone
Make key / New key (nowy klucz)	Tworzy klucz dla danej strony. Nowy klucz od razu unieważnia stary.
Remove key (usuń klucz)	Usuwa klucz tej strony. Aplikacje, które go używają, są odrzucane.
Let these apps delete files (pozwól tym aplikacjom usuwać pliki)	Gdy wyłączone, usunięcie tytułu w aplikacji zostawia pliki. Gdy włączone, pliki najpierw trafiają do folderu przechowywania, jak przy każdym usuwaniu w HolyArrs.	Wyłączone

Przy każdym kluczu karta pokazuje jego ostatnie 4 znaki, kto go utworzył i kiedy był ostatnio użyty.

Dla zaawansowanych

Wysyłanie klucza

HolyArrs czyta klucz z pierwszego miejsca, w którym go znajdzie, w tej kolejności. Zły klucz we wcześniejszym miejscu daje błąd, nawet jeśli klucz w dalszym miejscu jest dobry.

Kolejność	Miejsce	Przykład
1	wartość apikey w zapytaniu, wielkość liter bez znaczenia	/sonarr/api/v3/series?apikey=KEY
2	nagłówek X-Api-Key	X-Api-Key: KEY
3	nagłówek Authorization, z Bearer lub bez	Authorization: Bearer KEY

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

Forma z zapytaniem jest przyjmowana tylko pod tymi adresami, a HolyArrs ukrywa ją we własnym logu. Reverse proxy przed nim może nadal zapisywać pełny adres.

Zasady dotyczące kluczy

• Każda strona ma własny klucz, tworzony tylko na tej karcie. Klucze API HolyArrs (zaczynające się od hak_) tu nie działają, a te klucze nie działają nigdzie indziej.
• Klucz działa jako osoba, która go utworzyła, a ta musi mieć uprawnienie do zarządzania biblioteką. Prowlarr potrzebuje też uprawnienia do zmiany ustawień.
• Jeśli ta osoba zostanie wyłączona albo straci uprawnienie, aplikacje są odrzucane, dopóki ktoś nie utworzy nowego klucza. Karta cię o tym ostrzega.

Zarządzanie przez API HolyArrs

Zalogowany hasłem. Wywołania dotyczące kluczy wymagają niedawnego logowania hasłem.

Co	Wywołanie
Odczyt przełączników, adresów i kluczy	GET /api/v1/settings/old-app-api
Włączenie	PUT /api/v1/settings/old-app-api z {"enabled": true}
Pozwolenie aplikacjom na usuwanie plików	PUT /api/v1/settings/old-app-api z {"delete_files": true}
Utworzenie klucza po stronie Sonarr	POST /api/v1/settings/old-app-api/keys/sonarr
Utworzenie klucza po stronie Radarr	POST /api/v1/settings/old-app-api/keys/radarr
Usunięcie klucza	DELETE /api/v1/settings/old-app-api/keys/sonarr (lub radarr)

Powiązane strony

• Klienty API dotychczasowych aplikacji
• Ograniczenia API dotychczasowych aplikacji
• Reverse proxy i URL base