Saltar al contingut

API d'apps anteriors

Expert

Fes que una app que només coneix Sonarr o Radarr apunti a HolyArrs. Dóna-li una adreça que acabi en /sonarr o /radarr i una clau, i tractarà HolyArrs com aquella app.

És una API petita feta només per a aquestes apps. Per als teus propis scripts, fes servir l’API d’HolyArrs.

Està desactivada per defecte. Mentre ho està, totes les adreces sota /sonarr/ i /radarr/ responen 404.

  1. Obre Settings > API (Paràmetres > API).
  2. A la targeta Requests from Seerr and Overseerr (sol·licituds de Seerr i Overseerr), activa Answer Seerr and Overseerr (respon a Seerr i Overseerr).
  3. Clica a Make key (fes una clau) al costat de Shows (sèries). Aquesta és la clau del costat de Sonarr. Copia-la ara; només es mostra una vegada.
  4. Clica a Make key al costat de Movies (pel·lícules). Aquesta és la clau del costat de Radarr. Copia-la també.
  5. Anota l’adreça de cada costat a la targeta, com /sonarr. Sota una URL base mostra /holyarrs/sonarr. Fes servir el que mostra la targeta.

Fer una clau et torna a demanar la contrasenya si no has iniciat la sessió amb ella fa poc. Després configura cada app: mira Clients de l’API d’apps anteriors.

Paràmetres de la targeta

Enllaç a Paràmetres de la targeta
Paràmetre Què fa Per defecte
Answer Seerr and Overseerr Activa o desactiva /sonarr i /radarr alhora. Desactivat
Make key / New key (clau nova) Fa la clau d’aquell costat. Una clau nova atura l’antiga a l’instant.
Remove key (elimina la clau) Esborra la clau d’aquell costat. HolyArrs rebutja les apps que la fan servir.
Let these apps delete files Si està desactivat, eliminar un títol en una app deixa els fitxers. Si està activat, els fitxers van primer a la carpeta d’espera, com en qualsevol eliminació d’HolyArrs. Desactivat

De cada clau, la targeta mostra els últims 4 caràcters, qui l’ha feta i quan es va fer servir per última vegada.

Enviar la clau

HolyArrs llegeix la clau del primer lloc on la troba, en aquest ordre. Una clau incorrecta en un lloc anterior falla, encara que una de posterior sigui correcta.

Ordre Lloc Exemple
1 Valor apikey de la consulta, en majúscules o minúscules /sonarr/api/v3/series?apikey=KEY
2 Capçalera X-Api-Key X-Api-Key: KEY
3 Capçalera Authorization, amb o sense Bearer Authorization: Bearer KEY
Terminal window
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

La forma amb consulta només s’accepta en aquestes adreces, i HolyArrs l’amaga al seu propi registre. Un reverse proxy al davant pot continuar registrant l’adreça completa.

Regles de les claus
  • Cada costat té la seva pròpia clau, feta només en aquesta targeta. Les claus de l’API d’HolyArrs (que comencen per hak_) no funcionen aquí, i aquestes claus no funcionen enlloc més.
  • Una clau actua com la persona que l’ha feta, que ha de tenir permís per gestionar la Biblioteca. Prowlarr també necessita permís per canviar paràmetres.
  • Si aquesta persona es desactiva o perd el permís, HolyArrs rebutja les apps fins que algú faci una clau nova. La targeta t’ho adverteix.
Gestionar-la amb l'API d'HolyArrs

Amb la sessió iniciada amb la contrasenya. Les crides de claus necessiten un inici de sessió recent amb contrasenya.

Què Crida
Llegir interruptors, adreces i claus GET /api/v1/settings/old-app-api
Activar-la PUT /api/v1/settings/old-app-api amb {"enabled": true}
Deixar que les apps eliminin fitxers PUT /api/v1/settings/old-app-api amb {"delete_files": true}
Fer la clau del costat de Sonarr POST /api/v1/settings/old-app-api/keys/sonarr
Fer la clau del costat de Radarr POST /api/v1/settings/old-app-api/keys/radarr
Eliminar una clau DELETE /api/v1/settings/old-app-api/keys/sonarr (o radarr)

HolyArrs és gratis. Si t'ha estalviat temps, dona-li una estrella a GitHub, patrocina'l o convida'm a un cafè.