Sari la conținut

API-ul aplicațiilor mai vechi

Expert

Îndreaptă spre HolyArrs o aplicație care știe doar de Sonarr sau Radarr. Dă-i o adresă care se termină în /sonarr sau /radarr și o cheie, iar ea tratează HolyArrs ca pe acea aplicație.

Este un API mic, făcut doar pentru acele aplicații. Pentru propriile tale scripturi, folosește API-ul HolyArrs.

Vine oprit implicit. Cât timp e oprit, fiecare adresă de sub /sonarr/ și /radarr/ răspunde cu 404.

  1. Deschide Settings > API (Setări > API).
  2. Pe cardul Requests from Seerr and Overseerr (cereri de la Seerr și Overseerr), pornește Answer Seerr and Overseerr (răspunde la Seerr și Overseerr).
  3. Apasă Make key (creează o cheie) lângă Shows (seriale). Asta e cheia pentru partea Sonarr. Copiază-o acum; se arată o singură dată.
  4. Apasă Make key lângă Movies (filme). Asta e cheia pentru partea Radarr. Copiază-o și pe ea.
  5. Notează adresa fiecărei părți de pe card, de exemplu /sonarr. Sub un URL base se arată /holyarrs/sonarr. Folosește ce arată cardul.

Când creezi o cheie, ți se cere din nou parola dacă nu te-ai conectat cu ea de curând. Apoi configurează fiecare aplicație: vezi Clienții API-ului aplicațiilor mai vechi.

Setare Ce face Implicit
Answer Seerr and Overseerr Pornește sau oprește /sonarr și /radarr împreună. Oprit
Make key / New key (cheie nouă) Creează cheia pentru acea parte. O cheie nouă o oprește pe cea veche pe loc.
Remove key (șterge cheia) Șterge cheia acelei părți. Aplicațiile care o folosesc sunt refuzate.
Let these apps delete files Când e oprit, ștergerea unui titlu într-o aplicație lasă fișierele. Când e pornit, fișierele ajung întâi în dosarul de păstrare, ca la orice ștergere din HolyArrs. Oprit

Pentru fiecare cheie, cardul arată ultimele 4 caractere, cine a creat-o și când a fost folosită ultima oară.

Trimiterea cheii

HolyArrs citește cheia din primul loc în care o găsește, în ordinea asta. O cheie greșită într-un loc mai devreme eșuează, chiar dacă una de mai târziu e bună.

Ordine Loc Exemplu
1 valoarea apikey din adresă, cu orice litere /sonarr/api/v3/series?apikey=KEY
2 antetul X-Api-Key X-Api-Key: KEY
3 antetul Authorization, cu sau fără Bearer Authorization: Bearer KEY
Terminal window
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

Forma cu cheia în adresă e acceptată doar la aceste adrese, iar HolyArrs o ascunde în propriul jurnal. Un proxy invers aflat în față poate totuși să scrie adresa întreagă.

Regulile cheilor
  • Fiecare parte are cheia ei, creată doar pe acest card. Cheile API HolyArrs (care încep cu hak_) nu merg aici, iar aceste chei nu merg nicăieri altundeva.
  • O cheie acționează ca persoana care a creat-o, iar aceasta are nevoie de permisiunea de a gestiona Biblioteca. Prowlarr are nevoie și de permisiunea de a schimba setările.
  • Dacă acea persoană e oprită sau pierde permisiunea, aplicațiile sunt refuzate până când cineva creează o cheie nouă. Cardul te avertizează.
Gestionează-l cu API-ul HolyArrs

Conectat cu parola ta. Apelurile pentru chei cer o conectare recentă cu parola.

Ce Apel
Citește comutatoarele, adresele și cheile GET /api/v1/settings/old-app-api
Pornește-l PUT /api/v1/settings/old-app-api cu {"enabled": true}
Lasă aplicațiile să șteargă fișiere PUT /api/v1/settings/old-app-api cu {"delete_files": true}
Creează cheia pentru partea Sonarr POST /api/v1/settings/old-app-api/keys/sonarr
Creează cheia pentru partea Radarr POST /api/v1/settings/old-app-api/keys/radarr
Șterge o cheie DELETE /api/v1/settings/old-app-api/keys/sonarr (sau radarr)

HolyArrs este gratuit. Dacă ți-a economisit timp, dă-i o stea pe GitHub, sponsorizează-l sau cumpără-mi o cafea.