Eiti prie turinio
HolyArrsDocsHolyArrs.com

Ankstesnių programų API

Pažengusiam

Nukreipk programą, kuri pažįsta tik Sonarr ar Radarr, į HolyArrs. Duok jai adresą, pasibaigiantį /sonarr arba /radarr, ir raktą, ir ji laikys HolyArrs ta programa.

Tai nedidelis API, sukurtas tik toms programoms. Savo skriptams naudok HolyArrs API.

Įjungimas

Nuoroda į Įjungimas

Pagal numatymą jis išjungtas. Kol išjungtas, kiekvienas adresas po /sonarr/ ir /radarr/ atsako 404.

  1. Atidaryk Settings > API (nustatymai > API).
  2. Kortelėje Requests from Seerr and Overseerr (prašymai iš Seerr ir Overseerr) įjunk Answer Seerr and Overseerr (atsakyti Seerr ir Overseerr).
  3. Paspausk Make key (sukurti raktą) šalia Shows (serialai). Tai Sonarr pusės raktas. Nusikopijuok jį dabar; jis rodomas tik vieną kartą.
  4. Paspausk Make key šalia Movies (filmai). Tai Radarr pusės raktas. Nusikopijuok ir jį.
  5. Pasižymėk kiekvienos pusės adresą kortelėje, pavyzdžiui, /sonarr. Su URL base rodoma /holyarrs/sonarr. Naudok tai, ką rodo kortelė.

Kuriant raktą vėl paprašoma slaptažodžio, jei su juo neseniai neprisijungei. Tada nustatyk kiekvieną programą: žr. Ankstesnių programų API klientai.

Kortelės nustatymai

Nuoroda į Kortelės nustatymai
Nustatymas Ką daro Numatytasis
Answer Seerr and Overseerr Kartu įjungia arba išjungia /sonarr ir /radarr. Išjungta
Make key / New key (naujas raktas) Sukuria tos pusės raktą. Naujas raktas iškart sustabdo seną.
Remove key (pašalinti raktą) Ištrina tos pusės raktą. Jį naudojančios programos atmetamos.
Let these apps delete files Kai išjungta, pašalinus pavadinimą programoje, failai lieka. Kai įjungta, failai pirmiausia keliauja į laikymo aplanką, kaip ir po kiekvieno HolyArrs trynimo. Išjungta

Prie kiekvieno rakto kortelė rodo paskutinius 4 simbolius, kas jį sukūrė ir kada paskutinį kartą naudotas.

Pažengusiems

Nuoroda į Pažengusiems
Rakto siuntimas

HolyArrs skaito raktą iš pirmos vietos, kurioje jį randa, tokia tvarka. Neteisingas raktas ankstesnėje vietoje nepavyksta, net jei vėlesnėje raktas teisingas.

Nr. Vieta Pavyzdys
1 apikey užklausos reikšmė, bet kokiomis raidėmis (didžiosiomis ar mažosiomis) /sonarr/api/v3/series?apikey=KEY
2 X-Api-Key antraštė X-Api-Key: KEY
3 Authorization antraštė, su Bearer arba be jo Authorization: Bearer KEY
Terminal window
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

Užklausos forma priimama tik šiuose adresuose, o HolyArrs ją paslepia savo log. Priekyje esantis reverse proxy vis tiek gali įrašyti visą adresą.

Rakto taisyklės
  • Kiekviena pusė turi savo raktą, kuriamą tik šioje kortelėje. HolyArrs API raktai (prasidedantys hak_) čia neveikia, o šie raktai neveikia niekur kitur.
  • Raktas veikia kaip jį sukūręs žmogus, kuris turi turėti teisę valdyti Biblioteką. Prowlarr taip pat reikia teisės keisti nustatymus.
  • Jei tas žmogus išjungiamas arba netenka teisės, programos atmetamos, kol kas nors sukuria naują raktą. Kortelė tave įspėja.
Valdymas per HolyArrs API

Prisijungus su slaptažodžiu. Raktų kreipiniams reikia neseno prisijungimo slaptažodžiu.

Ką Kreipinys
Perskaityti jungiklius, adresus ir raktus GET /api/v1/settings/old-app-api
Įjungti PUT /api/v1/settings/old-app-api su {"enabled": true}
Leisti programoms trinti failus PUT /api/v1/settings/old-app-api su {"delete_files": true}
Sukurti Sonarr pusės raktą POST /api/v1/settings/old-app-api/keys/sonarr
Sukurti Radarr pusės raktą POST /api/v1/settings/old-app-api/keys/radarr
Pašalinti raktą DELETE /api/v1/settings/old-app-api/keys/sonarr (arba radarr)

Susiję puslapiai

Nuoroda į Susiję puslapiai

HolyArrs yra nemokama. Jei sutaupė tau laiko, pažymėk jį žvaigždute GitHub, paremk jį arba nupirk man kavos.