API des anciennes applications

Faites pointer vers HolyArrs une application qui ne connaît que Sonarr ou Radarr. Donnez-lui une adresse qui se termine par /sonarr ou /radarr et une clé, et elle traite HolyArrs comme cette application.

C’est une petite API faite uniquement pour ces applications. Pour vos propres scripts, utilisez l’API HolyArrs.

L’activer

Elle est désactivée par défaut. Tant qu’elle l’est, toute adresse sous /sonarr/ et /radarr/ répond 404.

1. Ouvrez Settings > API (Paramètres > API).
2. Sur la carte Requests from Seerr and Overseerr (demandes venant de Seerr et Overseerr), activez Answer Seerr and Overseerr (répondre à Seerr et Overseerr).
3. Appuyez sur Make key (créer une clé) à côté de Shows (séries). C’est la clé côté Sonarr. Copiez-la tout de suite ; elle n’est affichée qu’une fois.
4. Appuyez sur Make key à côté de Movies (films). C’est la clé côté Radarr. Copiez-la aussi.
5. Notez l’adresse de chaque côté sur la carte, par exemple /sonarr. Avec une URL de base, elle affiche /holyarrs/sonarr. Utilisez ce que la carte affiche.

Créer une clé vous redemande votre mot de passe si vous ne vous êtes pas connecté avec récemment. Configurez ensuite chaque application : voir Clients de l’API des anciennes applications.

Attention

Seerr stocke les clés en clair dans son fichier de paramètres. C’est pour ça que Let these apps delete files (laisser ces applications supprimer des fichiers) est désactivé par défaut.

Paramètres de la carte

Paramètre	Ce que ça fait	Valeur par défaut
Answer Seerr and Overseerr	Active ou désactive /sonarr et /radarr ensemble.	Désactivé
Make key / New key (nouvelle clé)	Crée la clé de ce côté. Une nouvelle clé coupe l’ancienne aussitôt.
Remove key (supprimer la clé)	Supprime la clé de ce côté. Les applications qui l’utilisent sont refusées.
Let these apps delete files	Désactivé, supprimer un titre dans une application laisse les fichiers. Activé, les fichiers passent d’abord par le dossier de rétention, comme toute suppression dans HolyArrs.	Désactivé

Pour chaque clé, la carte affiche ses 4 derniers caractères, qui l’a créée et quand elle a servi pour la dernière fois.

Pour les experts

Envoyer la clé

HolyArrs lit la clé au premier endroit où il la trouve, dans cet ordre. Une clé fausse à un endroit placé avant échoue, même si une clé placée après est bonne.

Ordre	Endroit	Exemple
1	Valeur apikey dans l’adresse, quelle que soit la casse	/sonarr/api/v3/series?apikey=KEY
2	En-tête X-Api-Key	X-Api-Key: KEY
3	En-tête Authorization, avec ou sans Bearer	Authorization: Bearer KEY

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

La forme dans l’adresse n’est acceptée que sur ces adresses, et HolyArrs la masque dans son propre journal. Un reverse proxy placé devant peut quand même écrire l’adresse complète dans le sien.

Règles des clés

• Chaque côté a sa propre clé, créée uniquement sur cette carte. Les clés API de HolyArrs (qui commencent par hak_) ne fonctionnent pas ici, et ces clés ne fonctionnent nulle part ailleurs.
• Une clé agit au nom de la personne qui l’a créée, qui a besoin de la permission de gérer la Bibliothèque. Prowlarr a aussi besoin de la permission de modifier les paramètres.
• Si cette personne est désactivée ou perd la permission, les applications sont refusées jusqu’à ce que quelqu’un crée une nouvelle clé. La carte vous prévient.

La gérer avec l'API HolyArrs

En étant connecté avec votre mot de passe. Les appels sur les clés demandent une connexion récente par mot de passe.

Quoi	Appel
Lire les interrupteurs, les adresses et les clés	GET /api/v1/settings/old-app-api
L’activer	PUT /api/v1/settings/old-app-api avec {"enabled": true}
Laisser les applications supprimer des fichiers	PUT /api/v1/settings/old-app-api avec {"delete_files": true}
Créer la clé côté Sonarr	POST /api/v1/settings/old-app-api/keys/sonarr
Créer la clé côté Radarr	POST /api/v1/settings/old-app-api/keys/radarr
Supprimer une clé	DELETE /api/v1/settings/old-app-api/keys/sonarr (ou radarr)

Voir aussi

• Clients de l’API des anciennes applications
• Limites de l’API des anciennes applications
• Reverse proxy et URL de base