API eldri forrita

Beindu forriti sem þekkir aðeins Sonarr eða Radarr á HolyArrs. Gefðu því vistfang sem endar á /sonarr eða /radarr og lykil, og það lítur á HolyArrs sem það forrit.

Þetta er lítið API sem er aðeins gert fyrir þessi forrit. Fyrir þín eigin skript skaltu nota HolyArrs API.

Kveikja á því

Það er sjálfgefið af. Meðan það er af svarar hvert vistfang undir /sonarr/ og /radarr/ 404.

1. Opnaðu Settings > API (stillingar > API).
2. Á spjaldinu Requests from Seerr and Overseerr (beiðnir frá Seerr og Overseerr) skaltu kveikja á Answer Seerr and Overseerr (svara Seerr og Overseerr).
3. Smelltu á Make key (búa til lykil) við hliðina á Shows (þættir). Þetta er lykillinn fyrir Sonarr-hliðina. Afritaðu hann núna; hann birtist aðeins einu sinni.
4. Smelltu á Make key við hliðina á Movies (kvikmyndir). Þetta er lykillinn fyrir Radarr-hliðina. Afritaðu hann líka.
5. Taktu eftir vistfanginu fyrir hvora hlið á spjaldinu, til dæmis /sonarr. Undir URL base birtist /holyarrs/sonarr. Notaðu það sem spjaldið sýnir.

Ef þú hefur ekki skráð þig inn með lykilorðinu nýlega biður HolyArrs um það aftur þegar lykill er búinn til. Settu svo upp hvert forrit: sjá Forrit sem nota API eldri forrita.

Caution

Seerr geymir lykla sem hreinan texta í stillingaskrá sinni. Þess vegna er Let these apps delete files (leyfa þessum forritum að eyða skrám) sjálfgefið af.

Stillingar spjaldsins

Stilling	Hvað hún gerir	Sjálfgefið
Answer Seerr and Overseerr	Kveikir eða slekkur á /sonarr og /radarr saman.	Slökkt
Make key / New key	Býr til lykil fyrir þá hlið. Nýr lykill stöðvar þann gamla strax.
Remove key	Eyðir lykli þeirrar hliðar. Forritum sem nota hann er hafnað.
Let these apps delete files	Þegar það er af skilur fjarlæging titils í forriti skrárnar eftir. Þegar það er á fara skrárnar fyrst í biðmöppuna, eins og við hverja eyðingu í HolyArrs.	Slökkt

Fyrir hvern lykil sýnir spjaldið síðustu 4 stafina, hver bjó hann til og hvenær hann var síðast notaður.

Fyrir sérfræðinga

Að senda lykilinn

HolyArrs les lykilinn frá fyrsta staðnum sem hann finnst á, í þessari röð. Rangur lykill á fyrri stað mistekst, jafnvel þótt sá síðari sé réttur.

Röð	Staður	Dæmi
1	apikey query-gildi, hvaða stafastærð sem er	/sonarr/api/v3/series?apikey=KEY
2	X-Api-Key haus	X-Api-Key: KEY
3	Authorization haus, með eða án Bearer	Authorization: Bearer KEY

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

Query-formið er aðeins samþykkt á þessum vistföngum og HolyArrs felur það í eigin log. Reverse proxy fyrir framan getur samt skráð allt vistfangið.

Reglur um lykla

• Hver hlið hefur sinn eigin lykil, sem er aðeins búinn til á þessu spjaldi. API-lyklar HolyArrs (sem byrja á hak_) virka ekki hér, og þessir lyklar virka hvergi annars staðar.
• Lykill starfar sem sá sem bjó hann til, og sá þarf heimild til að stjórna safninu. Prowlarr þarf líka heimild til að breyta stillingum.
• Ef sá aðili er gerður óvirkur eða missir heimildina er forritum hafnað þar til einhver býr til nýjan lykil. Spjaldið varar þig við.

Stjórna því með API HolyArrs

Innskráð með lykilorðinu þínu. Kall sem varða lykla krefjast nýlegrar innskráningar með lykilorði.

Hvað	Kall
Lesa rofa, vistföng og lykla	GET /api/v1/settings/old-app-api
Kveikja á því	PUT /api/v1/settings/old-app-api með {"enabled": true}
Leyfa forritum að eyða skrám	PUT /api/v1/settings/old-app-api með {"delete_files": true}
Búa til lykil fyrir Sonarr-hliðina	POST /api/v1/settings/old-app-api/keys/sonarr
Búa til lykil fyrir Radarr-hliðina	POST /api/v1/settings/old-app-api/keys/radarr
Fjarlægja lykil	DELETE /api/v1/settings/old-app-api/keys/sonarr (eða radarr)

Tengt efni

• Forrit sem nota API eldri forrita
• Takmörk API eldri forrita
• Reverse proxy og URL base