Korábbi appok API-ja

Irányíts egy olyan appot a HolyArrsre, amely csak a Sonarrt vagy a Radarrt ismeri. Adj neki egy /sonarr vagy /radarr végű címet és egy kulcsot, és úgy kezeli a HolyArrst, mintha az az app lenne.

Ez egy kis API, csak ezeknek az appoknak készült. A saját scriptjeidhez a HolyArrs API-t használd.

Kapcsold be

Alapból ki van kapcsolva. Amíg ki van kapcsolva, a /sonarr/ és /radarr/ alatti minden cím 404-et ad.

1. Nyisd meg a Settings > API (beállítások > API) oldalt.
2. A Requests from Seerr and Overseerr (kérések a Seerrből és az Overseerrből) kártyán kapcsold be az Answer Seerr and Overseerr (Seerr és Overseerr kiszolgálása) kapcsolót.
3. Kattints a Make key (kulcs készítése) gombra a Shows (sorozatok) mellett. Ez a Sonarr oldali kulcs. Másold ki most; csak egyszer látod.
4. Kattints a Make key gombra a Movies (filmek) mellett. Ez a Radarr oldali kulcs. Ezt is másold ki.
5. Jegyezd fel a kártyán mindkét oldal címét, például /sonarr. URL base esetén /holyarrs/sonarr látszik. Azt használd, amit a kártya mutat.

A kulcs készítésekor újra elkéri a jelszavadat, ha mostanában nem azzal jelentkeztél be. Utána állítsd be az appokat egyenként: lásd a Korábbi appok API-kliensei oldalt.

Figyelem

A Seerr a kulcsokat sima szövegként tárolja a beállításfájljában. Ezért van alapból kikapcsolva a Let these apps delete files (engedd, hogy ezek az appok fájlokat töröljenek) beállítás.

A kártya beállításai

Beállítás	Mit csinál	Alapérték
Answer Seerr and Overseerr	A /sonarr és a /radarr címet együtt kapcsolja be vagy ki.	Ki
Make key / New key (új kulcs)	Elkészíti az adott oldal kulcsát. Az új kulcs azonnal leállítja a régit.
Remove key (kulcs eltávolítása)	Törli az adott oldal kulcsát. Az azt használó appokat elutasítja.
Let these apps delete files	Ha ki van kapcsolva, egy cím eltávolítása egy appban a fájlokat meghagyja. Ha be van kapcsolva, a fájlok előbb a tárolómappába kerülnek, mint minden HolyArrs-törlésnél.	Ki

A kártya minden kulcsnál megmutatja az utolsó 4 karakterét, hogy ki készítette, és mikor használták utoljára.

Haladóknak

A kulcs elküldése

A HolyArrs a kulcsot az első helyről olvassa, ahol megtalálja, ebben a sorrendben. Egy korábbi helyen megadott rossz kulcs hibát ad, akkor is, ha egy későbbi helyen jó van.

Sorrend	Hely	Példa
1	apikey lekérdezési érték, kis- és nagybetűtől függetlenül	/sonarr/api/v3/series?apikey=KEY
2	X-Api-Key fejléc	X-Api-Key: KEY
3	Authorization fejléc, Bearer előtaggal vagy anélkül	Authorization: Bearer KEY

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

A lekérdezéses forma csak ezeken a címeken fogadható el, és a HolyArrs elrejti a saját logjában. Az előtte álló reverse proxy még logolhatja a teljes címet.

A kulcsok szabályai

• Minden oldalnak saját kulcsa van, amelyet csak ezen a kártyán lehet elkészíteni. A HolyArrs API-kulcsai (amelyek hak_-kal kezdődnek) itt nem működnek, és ezek a kulcsok sehol máshol nem működnek.
• A kulcs annak a nevében jár el, aki készítette, és neki jogosultság kell a médiatár kezeléséhez. A Prowlarrhoz ezenkívül a beállítások módosításának joga is kell.
• Ha az az ember ki van kapcsolva, vagy elveszti a jogosultságot, az appokat elutasítja a rendszer, amíg valaki új kulcsot nem készít. A kártya figyelmeztet erre.

Kezelés a HolyArrs API-val

A jelszavaddal bejelentkezve. A kulcsos hívásokhoz friss jelszavas bejelentkezés kell.

Mit	Hívás
Kapcsolók, címek és kulcsok olvasása	GET /api/v1/settings/old-app-api
Bekapcsolás	PUT /api/v1/settings/old-app-api ezzel: {"enabled": true}
Fájltörlés engedélyezése az appoknak	PUT /api/v1/settings/old-app-api ezzel: {"delete_files": true}
A Sonarr oldali kulcs készítése	POST /api/v1/settings/old-app-api/keys/sonarr
A Radarr oldali kulcs készítése	POST /api/v1/settings/old-app-api/keys/radarr
Kulcs eltávolítása	DELETE /api/v1/settings/old-app-api/keys/sonarr (vagy radarr)

Kapcsolódó oldalak

• Korábbi appok API-kliensei
• Korábbi appok API-jának korlátai
• Reverse proxy és URL base