Aiempien sovellusten API

Osoita sovellus, joka tuntee vain Sonarrin tai Radarrin, HolyArrsiin. Anna sille osoite, joka päättyy /sonarr tai /radarr, sekä avain, niin se kohtelee HolyArrsia kyseisenä sovelluksena.

Tämä on pieni API, joka on tehty vain näille sovelluksille. Omiin skripteihisi käytä HolyArrsin API:a.

Ota käyttöön

Se on oletuksena pois päältä. Kun se on pois, jokainen osoite polun /sonarr/ ja /radarr/ alla vastaa 404.

1. Avaa Settings > API (asetukset > API).
2. Ota kortissa Requests from Seerr and Overseerr (pyynnöt Seerristä ja Overseerristä) käyttöön Answer Seerr and Overseerr (vastaa Seerrille ja Overseerrille).
3. Napsauta Make key (tee avain) kohdan Shows (sarjat) vieressä. Tämä on Sonarr-puolen avain. Kopioi se nyt; se näytetään vain kerran.
4. Napsauta Make key kohdan Movies (elokuvat) vieressä. Tämä on Radarr-puolen avain. Kopioi sekin.
5. Merkitse muistiin kummankin puolen osoite kortista, esimerkiksi /sonarr. Kun käytössä on URL base, se näkyy muodossa /holyarrs/sonarr. Käytä sitä, mitä kortti näyttää.

Avaimen tekeminen kysyy salasanaa uudelleen, jos et ole kirjautunut sillä äskettäin. Ota sitten käyttöön jokainen sovellus: katso Aiempien sovellusten API:n clientit.

Varoitus

Seerr tallentaa avaimet asetustiedostoonsa selkotekstinä. Siksi Let these apps delete files (anna näiden sovellusten poistaa tiedostoja) on oletuksena pois päältä.

Kortin asetukset

Asetus	Mitä se tekee	Oletus
Answer Seerr and Overseerr	Ottaa /sonarr- ja /radarr-osoitteet käyttöön tai pois käytöstä yhdessä.	Pois
Make key / New key (uusi avain)	Tekee avaimen kyseiselle puolelle. Uusi avain mitätöi vanhan heti.
Remove key (poista avain)	Poistaa kyseisen puolen avaimen. Sitä käyttävät sovellukset hylätään.
Let these apps delete files	Kun pois päältä, nimikkeen poistaminen sovelluksessa jättää tiedostot. Kun päällä, tiedostot menevät ensin säilytyskansioon, kuten jokaisessa HolyArrsin poistossa.	Pois

Jokaisesta avaimesta kortti näyttää sen 4 viimeistä merkkiä, kuka sen teki ja milloin sitä käytettiin viimeksi.

Asiantuntijoille

Avaimen lähettäminen

HolyArrs lukee avaimen ensimmäisestä paikasta, josta se sen löytää, tässä järjestyksessä. Väärä avain aiemmassa paikassa epäonnistuu, vaikka myöhempi olisi oikea.

Järjestys	Paikka	Esimerkki
1	apikey-kyselyarvo, mikä tahansa kirjainkoko	/sonarr/api/v3/series?apikey=KEY
2	X-Api-Key-otsikko	X-Api-Key: KEY
3	Authorization-otsikko, Bearer -etuliitteellä tai ilman	Authorization: Bearer KEY

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

Kyselymuoto hyväksytään vain näissä osoitteissa, ja HolyArrs piilottaa sen omasta lokistaan. Edessä oleva reverse proxy voi silti kirjata koko osoitteen.

Avainten säännöt

• Kummallakin puolella on oma avaimensa, joka tehdään vain tässä kortissa. HolyArrsin API-avaimet (jotka alkavat hak_) eivät toimi täällä, eivätkä nämä avaimet toimi missään muualla.
• Avain toimii sen ihmisen puolesta, joka sen teki, ja hänellä pitää olla oikeus hallita kirjastoa. Prowlarr tarvitsee lisäksi oikeuden muuttaa asetuksia.
• Jos kyseinen ihminen poistetaan käytöstä tai menettää oikeuden, sovellukset hylätään, kunnes joku tekee uuden avaimen. Kortti varoittaa siitä.

Hallinta HolyArrsin API:lla

Kirjautuneena salasanallasi. Avainkutsut vaativat äskettäisen salasanakirjautumisen.

Mitä	Kutsu
Lue kytkimet, osoitteet ja avaimet	GET /api/v1/settings/old-app-api
Ota käyttöön	PUT /api/v1/settings/old-app-api ja {"enabled": true}
Anna sovellusten poistaa tiedostoja	PUT /api/v1/settings/old-app-api ja {"delete_files": true}
Tee Sonarr-puolen avain	POST /api/v1/settings/old-app-api/keys/sonarr
Tee Radarr-puolen avain	POST /api/v1/settings/old-app-api/keys/radarr
Poista avain	DELETE /api/v1/settings/old-app-api/keys/sonarr (tai radarr)

Aiheesta lisää

• Aiempien sovellusten API:n clientit
• Aiempien sovellusten API:n rajat
• Reverse proxy ja URL base