Old-app API

Ituro sa HolyArrs ang app na Sonarr o Radarr lang ang kilala. Bigyan ito ng address na nagtatapos sa /sonarr o /radarr at ng key, at ituturing nito ang HolyArrs bilang app na iyon.

Isa itong maliit na API na ginawa para sa mga app na iyon lang. Para sa sarili mong mga script, gamitin ang HolyArrs API.

I-on ito

Naka-off ito bilang default. Habang naka-off, 404 ang sagot ng bawat address sa ilalim ng /sonarr/ at /radarr/.

1. Buksan ang Settings > API.
2. Sa card na Requests from Seerr and Overseerr (mga kahilingan mula sa Seerr at Overseerr), i-on ang Answer Seerr and Overseerr (sagutin ang Seerr at Overseerr).
3. I-click ang Make key (gumawa ng key) sa tabi ng Shows (mga palabas). Ito ang key ng panig ng Sonarr. Kopyahin ito ngayon; isang beses lang ito ipinapakita.
4. I-click ang Make key sa tabi ng Movies (mga pelikula). Ito ang key ng panig ng Radarr. Kopyahin din ito.
5. Tandaan ang address ng bawat panig sa card, tulad ng /sonarr. Kapag may URL base, /holyarrs/sonarr ang ipinapakita. Gamitin ang ipinapakita ng card.

Kapag gumagawa ng key, hihingin ulit ang password mo kung hindi ka pa kamakailang nag-sign in gamit ito. Pagkatapos, i-set up ang bawat app: tingnan ang Mga client ng old-app API.

Caution

Iniimbak ng Seerr ang mga key bilang plain text sa settings file nito. Iyan ang dahilan kung bakit naka-off bilang default ang Let these apps delete files (hayaang magbura ng file ang mga app na ito).

Mga setting ng card

Setting	Ano ang ginagawa	Default
Answer Seerr and Overseerr	Sabay na ino-on o ino-off ang /sonarr at /radarr.	Off
Make key / New key	Gumagawa ng key para sa panig na iyon. Ang bagong key ay agad na nagpapahinto sa luma.
Remove key	Binubura ang key ng panig na iyon. Tinatanggihan ang mga app na gumagamit nito.
Let these apps delete files	Kapag naka-off, nananatili ang mga file kapag inalis ang pamagat sa app. Kapag naka-on, mapupunta muna ang mga file sa holding folder, tulad ng bawat pagbura sa HolyArrs.	Off

Para sa bawat key, ipinapakita ng card ang huling 4 na karakter nito, kung sino ang gumawa at kung kailan ito huling ginamit.

Para sa mga eksperto

Pagpapadala ng key

Binabasa ng HolyArrs ang key mula sa unang lugar na makita nito, ayon sa pagkakasunod na ito. Pumapalya ang maling key sa naunang lugar, kahit tama ang nasa sumunod.

Pagkakasunod	Lugar	Halimbawa
1	apikey query value, anumang case	/sonarr/api/v3/series?apikey=KEY
2	X-Api-Key header	X-Api-Key: KEY
3	Authorization header, may Bearer man o wala	Authorization: Bearer KEY

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

Tinatanggap lang ang query form sa mga address na ito, at itinatago ito ng HolyArrs sa sarili nitong log. Maaari pa ring i-log ng reverse proxy sa harap ang buong address.

Mga patakaran sa key

• May sariling key ang bawat panig, ginagawa lang sa card na ito. Hindi gumagana rito ang mga API key ng HolyArrs (na nagsisimula sa hak_), at hindi gumagana kahit saan pa ang mga key na ito.
• Kumikilos ang key bilang taong gumawa nito, na kailangang may permiso na mamahala ng Aklatan. Kailangan din ng Prowlarr ng permiso na magbago ng settings.
• Kung na-off ang taong iyon o nawala ang permiso niya, tatanggihan ang mga app hanggang may gumawa ng bagong key. Nagbababala ang card.

Pamahalaan gamit ang HolyArrs API

Naka-sign in gamit ang password mo. Ang mga tawag sa key ay nangangailangan ng kamakailang sign-in gamit ang password.

Ano	Tawag
Basahin ang mga switch, address at key	GET /api/v1/settings/old-app-api
I-on	PUT /api/v1/settings/old-app-api na may {"enabled": true}
Hayaang magbura ng file ang mga app	PUT /api/v1/settings/old-app-api na may {"delete_files": true}
Gumawa ng key ng panig ng Sonarr	POST /api/v1/settings/old-app-api/keys/sonarr
Gumawa ng key ng panig ng Radarr	POST /api/v1/settings/old-app-api/keys/radarr
Mag-alis ng key	DELETE /api/v1/settings/old-app-api/keys/sonarr (o radarr)

Kaugnay

• Mga client ng old-app API
• Mga limitasyon ng old-app API
• Reverse proxy at URL base