API voor eerdere apps

Wijs een app die alleen Sonarr of Radarr kent naar HolyArrs. Geef hem een adres dat eindigt op /sonarr of /radarr en een sleutel, en hij behandelt HolyArrs als die app.

Dit is een kleine API die alleen voor die apps is gemaakt. Gebruik voor je eigen scripts de HolyArrs-API.

Aanzetten

Standaard staat het uit. Zolang het uit staat, geeft elk adres onder /sonarr/ en /radarr/ een 404.

1. Open Settings > API (instellingen > API).
2. Zet op de kaart Requests from Seerr and Overseerr (aanvragen van Seerr en Overseerr) Answer Seerr and Overseerr (Seerr en Overseerr beantwoorden) aan.
3. Klik op Make key (sleutel maken) naast Shows (series). Dit is de Sonarr-sleutel. Kopieer hem nu; je ziet hem maar één keer.
4. Klik op Make key naast Movies (films). Dit is de Radarr-sleutel. Kopieer ook die.
5. Noteer het adres van elke kant op de kaart, zoals /sonarr. Onder een URL base staat er /holyarrs/sonarr. Gebruik wat de kaart toont.

Als je je niet kort geleden met je wachtwoord hebt aangemeld, vraagt HolyArrs er bij het maken van een sleutel opnieuw om. Stel daarna elke app in: zie Clients van de API voor eerdere apps.

Opgepast

Seerr slaat sleutels als gewone tekst op in zijn instellingenbestand. Daarom staat Let these apps delete files (deze apps bestanden laten verwijderen) standaard uit.

Instellingen op de kaart

Instelling	Wat het doet	Standaard
Answer Seerr and Overseerr	Zet /sonarr en /radarr samen aan of uit.	Uit
Make key / New key (nieuwe sleutel)	Maakt de sleutel voor die kant. Een nieuwe sleutel stopt de oude meteen.
Remove key (sleutel verwijderen)	Verwijdert de sleutel van die kant. Apps die hem gebruiken, worden geweigerd.
Let these apps delete files	Als het uit staat, laat het verwijderen van een titel in een app de bestanden staan. Als het aan staat, gaan bestanden eerst naar de wachtmap, zoals bij elke verwijdering in HolyArrs.	Uit

Bij elke sleutel toont de kaart de laatste 4 tekens, wie hem heeft gemaakt en wanneer hij voor het laatst is gebruikt.

Voor gevorderden

De sleutel meesturen

HolyArrs leest de sleutel op de eerste plek waar hij staat, in deze volgorde. Een foute sleutel op een eerdere plek mislukt, ook als een latere plek klopt.

Volgorde	Plek	Voorbeeld
1	Queryvalue apikey, in elke schrijfwijze	/sonarr/api/v3/series?apikey=KEY
2	Header X-Api-Key	X-Api-Key: KEY
3	Header Authorization, met of zonder Bearer	Authorization: Bearer KEY

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

De queryvorm wordt alleen op deze adressen geaccepteerd, en HolyArrs verbergt hem in zijn eigen log. Een reverse proxy ervoor kan het volledige adres nog wel loggen.

Regels voor sleutels

• Elke kant heeft een eigen sleutel, die je alleen op deze kaart maakt. API-sleutels van HolyArrs (die beginnen met hak_) werken hier niet, en deze sleutels werken nergens anders.
• Een sleutel handelt namens degene die hem heeft gemaakt, die het recht moet hebben om de bibliotheek te beheren. Prowlarr heeft ook het recht nodig om instellingen te wijzigen.
• Als die persoon wordt uitgezet of het recht verliest, worden apps geweigerd totdat iemand een nieuwe sleutel maakt. De kaart waarschuwt je.

Beheren met de HolyArrs-API

Aangemeld met je wachtwoord. Voor aanroepen met sleutels is een recente aanmelding met wachtwoord nodig.

Wat	Aanroep
Schakelaars, adressen en sleutels lezen	GET /api/v1/settings/old-app-api
Aanzetten	PUT /api/v1/settings/old-app-api met {"enabled": true}
Apps bestanden laten verwijderen	PUT /api/v1/settings/old-app-api met {"delete_files": true}
De Sonarr-sleutel maken	POST /api/v1/settings/old-app-api/keys/sonarr
De Radarr-sleutel maken	POST /api/v1/settings/old-app-api/keys/radarr
Een sleutel verwijderen	DELETE /api/v1/settings/old-app-api/keys/sonarr (of radarr)

Gerelateerde pagina’s

• Clients van de API voor eerdere apps
• Grenzen van de API voor eerdere apps
• Reverse proxy en URL base