Iepriekšējo lietotņu API

Norādi lietotnei, kas pazīst tikai Sonarr vai Radarr, uz HolyArrs. Iedod tai adresi, kas beidzas ar /sonarr vai /radarr, un atslēgu, un tā uztvers HolyArrs kā šo lietotni.

Šis ir neliels API, kas veidots tikai šīm lietotnēm. Saviem skriptiem izmanto HolyArrs API.

Ieslēgšana

Pēc noklusējuma tas ir izslēgts. Kamēr tas ir izslēgts, katra adrese zem /sonarr/ un /radarr/ atbild ar 404.

1. Atver Settings > API (iestatījumi > API).
2. Kartītē Requests from Seerr and Overseerr (pieprasījumi no Seerr un Overseerr) ieslēdz Answer Seerr and Overseerr (atbildēt Seerr un Overseerr).
3. Noklikšķini uz Make key (izveidot atslēgu) blakus Shows (seriāli). Šī ir Sonarr puses atslēga. Nokopē to tagad; tā tiek parādīta vienu reizi.
4. Noklikšķini uz Make key blakus Movies (filmas). Šī ir Radarr puses atslēga. Nokopē arī to.
5. Pieraksti katras puses adresi no kartītes, piemēram, /sonarr. Ja ir URL base, tiek rādīts /holyarrs/sonarr. Izmanto to, ko rāda kartīte.

Atslēgas izveide prasa tavu paroli vēlreiz, ja nesen neesi pieteicies ar to. Pēc tam iestati katru lietotni: skaties Iepriekšējo lietotņu API klienti.

Uzmanību

Seerr glabā atslēgas vienkāršā tekstā savā iestatījumu failā. Tāpēc Let these apps delete files (ļaut šīm lietotnēm dzēst failus) pēc noklusējuma ir izslēgts.

Kartītes iestatījumi

Iestatījums	Ko tas dara	Noklusējums
Answer Seerr and Overseerr	Ieslēdz vai izslēdz /sonarr un /radarr kopā.	Izslēgts
Make key / New key	Izveido atslēgu šai pusei. Jauna atslēga uzreiz aptur veco.
Remove key	Izdzēš šīs puses atslēgu. Lietotnes, kas to izmanto, tiek noraidītas.
Let these apps delete files	Kad izslēgts, nosaukuma noņemšana lietotnē atstāj failus. Kad ieslēgts, faili vispirms nonāk aizturēšanas mapē, tāpat kā katrā HolyArrs dzēšanā.	Izslēgts

Katrai atslēgai kartīte rāda tās pēdējās 4 rakstzīmes, to, kas to izveidoja, un to, kad tā pēdējo reizi izmantota.

Pieredzējušiem

Atslēgas nosūtīšana

HolyArrs nolasa atslēgu no pirmās vietas, kur to atrod, šādā secībā. Nepareiza atslēga agrākā vietā izraisa kļūdu, pat ja vēlākā vietā ir pareizā.

Secība	Vieta	Piemērs
1	apikey vaicājuma vērtība, jebkurā burtu reģistrā	/sonarr/api/v3/series?apikey=KEY
2	X-Api-Key galvene	X-Api-Key: KEY
3	Authorization galvene, ar Bearer vai bez	Authorization: Bearer KEY

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

Vaicājuma forma tiek pieņemta tikai šajās adresēs, un HolyArrs to paslēpj savā žurnālā. Reversais starpniekserveris (reverse proxy) priekšā joprojām var reģistrēt pilnu adresi.

Atslēgu noteikumi

• Katrai pusei ir sava atslēga, ko izveido tikai šajā kartītē. HolyArrs API atslēgas (kas sākas ar hak_) šeit nedarbojas, un šīs atslēgas nedarbojas nekur citur.
• Atslēga darbojas kā cilvēks, kas to izveidoja, un viņam vajadzīga atļauja pārvaldīt bibliotēku. Prowlarr vajadzīga arī atļauja mainīt iestatījumus.
• Ja šis cilvēks tiek izslēgts vai zaudē atļauju, lietotnes tiek noraidītas, līdz kāds izveido jaunu atslēgu. Kartīte tev par to brīdina.

Pārvaldīšana ar HolyArrs API

Jābūt pieteikušamies ar savu paroli. Atslēgu izsaukumiem vajadzīga nesena pieteikšanās ar paroli.

Ko	Izsaukums
Nolasīt slēdžus, adreses un atslēgas	GET /api/v1/settings/old-app-api
Ieslēgt	PUT /api/v1/settings/old-app-api ar {"enabled": true}
Ļaut lietotnēm dzēst failus	PUT /api/v1/settings/old-app-api ar {"delete_files": true}
Izveidot Sonarr puses atslēgu	POST /api/v1/settings/old-app-api/keys/sonarr
Izveidot Radarr puses atslēgu	POST /api/v1/settings/old-app-api/keys/radarr
Noņemt atslēgu	DELETE /api/v1/settings/old-app-api/keys/sonarr (vai radarr)

Saistītais

• Iepriekšējo lietotņu API klienti
• Iepriekšējo lietotņu API ierobežojumi
• Reversais starpniekserveris un URL base