Vanade rakenduste API

Suuna rakendus, mis tunneb ainult Sonarri või Radarrit, HolyArrsi poole. Anna talle aadress, mis lõpeb /sonarr või /radarr, ja võti, ning ta peab HolyArrsi selleks rakenduseks.

See on väike API, mis on tehtud ainult nende rakenduste jaoks. Oma skriptide jaoks kasuta HolyArrsi API-t.

Lülita sisse

See on vaikimisi väljas. Kui see on väljas, vastab iga aadress, mis algab /sonarr/ või /radarr/, veaga 404.

1. Ava Settings > API (seaded > API).
2. Lülita kaardil Requests from Seerr and Overseerr (soovid Seerrist ja Overseerrist) sisse Answer Seerr and Overseerr (vasta Seerrile ja Overseerrile).
3. Vajuta Shows (sarjad) kõrval nuppu Make key (tee võti). See on Sonarri poole võti. Kopeeri see kohe; seda näidatakse ainult üks kord.
4. Vajuta Movies (filmid) kõrval nuppu Make key. See on Radarri poole võti. Kopeeri ka see.
5. Pane kaardil tähele kummagi poole aadressi, näiteks /sonarr. URL base’i korral näitab see /holyarrs/sonarr. Kasuta seda, mida kaart näitab.

Võtme tegemisel küsitakse uuesti sinu parooli, kui sa pole sellega hiljuti sisse loginud. Seejärel seadista iga rakendus: vaata Vanade rakenduste API kliendid.

Caution

Seerr salvestab võtmed oma seadetefailis lihttekstina. Seetõttu on Let these apps delete files vaikimisi väljas.

Kaardi sätted

Säte	Mida teeb	Vaikeväärtus
Answer Seerr and Overseerr	Lülitab /sonarr ja /radarr koos sisse või välja.	Väljas
Make key / New key (uus võti)	Teeb selle poole võtme. Uus võti peatab vana kohe.
Remove key (eemalda võti)	Kustutab selle poole võtme. Seda kasutavad rakendused lükatakse tagasi.
Let these apps delete files (lase neil rakendustel faile kustutada)	Kui see on väljas, jätab pealkirja eemaldamine rakenduses failid alles. Kui sees, lähevad failid esmalt hoiukausta, nagu iga HolyArrsi kustutamine.	Väljas

Iga võtme kohta näitab kaart selle viimast nelja märki, kes selle tegi ja millal seda viimati kasutati.

Asjatundjale

Võtme saatmine

HolyArrs loeb võtme esimesest kohast, kust ta selle leiab, selles järjekorras. Vale võti varasemas kohas ebaõnnestub, isegi kui hilisem on õige.

Järjekord	Koht	Näide
1	apikey päringuväärtus, tähesuurus pole oluline	/sonarr/api/v3/series?apikey=KEY
2	X-Api-Key päis	X-Api-Key: KEY
3	Authorization päis, Bearer -iga või ilma	Authorization: Bearer KEY

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

Päringuvormi aktsepteeritakse ainult nendel aadressidel ja HolyArrs peidab selle oma logis. Ees olev reverse proxy võib täisaadressi siiski logida.

Võtmete reeglid

• Igal poolel on oma võti, mis tehakse ainult sellel kaardil. HolyArrsi API võtmed (mis algavad hak_) siin ei tööta ja need võtmed ei tööta mujal.
• Võti tegutseb selle inimesena, kes selle tegi, ja tal peab olema õigus meediakogu hallata. Prowlarr vajab ka õigust seadeid muuta.
• Kui see inimene lülitatakse välja või kaotab õiguse, lükatakse rakendused tagasi, kuni keegi teeb uue võtme. Kaart hoiatab sind.

Halda seda HolyArrsi API-ga

Sisselogituna oma parooliga. Võtmepäringud vajavad hiljutist parooliga sisselogimist.

Mida	Päring
Loe lüliteid, aadresse ja võtmeid	GET /api/v1/settings/old-app-api
Lülita sisse	PUT /api/v1/settings/old-app-api koos {"enabled": true}
Lase rakendustel faile kustutada	PUT /api/v1/settings/old-app-api koos {"delete_files": true}
Tee Sonarri poole võti	POST /api/v1/settings/old-app-api/keys/sonarr
Tee Radarri poole võti	POST /api/v1/settings/old-app-api/keys/radarr
Eemalda võti	DELETE /api/v1/settings/old-app-api/keys/sonarr (või radarr)

Seotud lehed

• Vanade rakenduste API kliendid
• Vanade rakenduste API piirangud
• Reverse proxy ja URL base