API for tidligere apper

Pek en app som bare kjenner Sonarr eller Radarr mot HolyArrs. Gi den en adresse som slutter på /sonarr eller /radarr og en nøkkel, så behandler den HolyArrs som den appen.

Dette er et lite API laget bare for slike apper. Til dine egne skript bruker du API-et til HolyArrs.

Slå det på

Det er av som standard. Mens det er av, svarer hver adresse under /sonarr/ og /radarr/ med 404.

1. Åpne Settings > API (innstillinger > API).
2. På kortet Requests from Seerr and Overseerr (forespørsler fra Seerr og Overseerr) slår du på Answer Seerr and Overseerr (svar Seerr og Overseerr).
3. Trykk på Make key (lag nøkkel) ved siden av Shows (serier). Dette er nøkkelen for Sonarr-siden. Kopier den nå; den vises bare én gang.
4. Trykk på Make key ved siden av Movies (filmer). Dette er nøkkelen for Radarr-siden. Kopier den også.
5. Noter adressen for hver side på kortet, for eksempel /sonarr. Under en URL base vises den som /holyarrs/sonarr. Bruk det kortet viser.

Når du lager en nøkkel, må du skrive inn passordet på nytt hvis du ikke har logget inn med det nylig. Sett så opp hver app: se Klienter for API-et til tidligere apper.

Advarsel

Seerr lagrer nøkler som ren tekst i innstillingsfilen sin. Derfor er Let these apps delete files (la disse appene slette filer) av som standard.

Innstillinger på kortet

Innstilling	Hva den gjør	Standard
Answer Seerr and Overseerr	Slår /sonarr og /radarr på eller av samtidig.	Av
Make key / New key (ny nøkkel)	Lager nøkkelen for den siden. En ny nøkkel stopper den gamle med en gang.
Remove key (fjern nøkkel)	Sletter nøkkelen til den siden. Apper som bruker den, blir avvist.
Let these apps delete files	Når den er av, lar fjerning av en tittel i en app filene ligge. Når den er på, går filene først til mappen for tilbakeholdte filer, som ved alle andre slettinger i HolyArrs.	Av

For hver nøkkel viser kortet de 4 siste tegnene, hvem som lagde den og når den sist ble brukt.

For viderekomne

Sende nøkkelen

HolyArrs leser nøkkelen fra det første stedet den finner den, i denne rekkefølgen. En feil nøkkel på et tidligere sted feiler, selv om en senere er riktig.

Rekkefølge	Sted	Eksempel
1	apikey som query-verdi, uansett store eller små bokstaver	/sonarr/api/v3/series?apikey=KEY
2	X-Api-Key-header	X-Api-Key: KEY
3	Authorization-header, med eller uten Bearer	Authorization: Bearer KEY

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

Query-formen godtas bare på disse adressene, og HolyArrs skjuler den i sin egen logg. En reverse proxy foran kan fortsatt logge hele adressen.

Regler for nøkler

• Hver side har sin egen nøkkel, som bare lages på dette kortet. API-nøkler til HolyArrs (som begynner med hak_) fungerer ikke her, og disse nøklene fungerer ingen andre steder.
• En nøkkel virker som personen som lagde den, og den personen trenger tillatelse til å administrere biblioteket. Prowlarr trenger også tillatelse til å endre innstillinger.
• Hvis den personen slås av eller mister tillatelsen, blir apper avvist til noen lager en ny nøkkel. Kortet advarer deg.

Administrer det med API-et til HolyArrs

Du må være innlogget med passordet ditt. Nøkkelkall krever en nylig innlogging med passord.

Hva	Kall
Les bryterne, adressene og nøklene	GET /api/v1/settings/old-app-api
Slå det på	PUT /api/v1/settings/old-app-api med {"enabled": true}
La apper slette filer	PUT /api/v1/settings/old-app-api med {"delete_files": true}
Lag nøkkelen for Sonarr-siden	POST /api/v1/settings/old-app-api/keys/sonarr
Lag nøkkelen for Radarr-siden	POST /api/v1/settings/old-app-api/keys/radarr
Fjern en nøkkel	DELETE /api/v1/settings/old-app-api/keys/sonarr (eller radarr)

Relatert

• Klienter for API-et til tidligere apper
• Grenser for API-et til tidligere apper
• Reverse proxy og URL base