API das apps anteriores

Aponta para o HolyArrs uma app que só conhece o Sonarr ou o Radarr. Dá-lhe um endereço que termina em /sonarr ou /radarr e uma chave, e ela trata o HolyArrs como essa app.

É uma API pequena, feita só para essas apps. Para os teus próprios scripts, usa a API do HolyArrs.

Ativar

Vem desativada. Enquanto estiver desativada, todos os endereços em /sonarr/ e /radarr/ respondem 404.

1. Abre Settings > API (Definições > API).
2. No cartão Requests from Seerr and Overseerr (pedidos do Seerr e do Overseerr), ativa Answer Seerr and Overseerr (responder ao Seerr e ao Overseerr).
3. Clica em Make key (criar chave) ao lado de Shows (séries). Esta é a chave do lado do Sonarr. Copia-a agora; só é mostrada uma vez.
4. Clica em Make key ao lado de Movies (filmes). Esta é a chave do lado do Radarr. Copia-a também.
5. Anota o endereço de cada lado no cartão, como /sonarr. Com um URL base, aparece /holyarrs/sonarr. Usa o que o cartão mostra.

Criar uma chave pede outra vez a tua palavra-passe se não iniciaste sessão com ela há pouco tempo. Depois configura cada app: vê Clientes da API das apps anteriores.

Cuidado

O Seerr guarda as chaves em texto simples no ficheiro de definições dele. É por isso que Let these apps delete files vem desativado por predefinição.

Definições do cartão

Definição	O que faz	Predefinição
Answer Seerr and Overseerr	Liga ou desliga /sonarr e /radarr em conjunto.	Desativado
Make key / New key (chave nova)	Cria a chave desse lado. Uma chave nova faz parar a antiga de imediato.
Remove key (remover chave)	Apaga a chave desse lado. As apps que a usam são recusadas.
Let these apps delete files (deixar estas apps apagar ficheiros)	Desativado, remover um título numa app deixa os ficheiros. Ativado, os ficheiros vão primeiro para a pasta de retenção, como em qualquer remoção do HolyArrs.	Desativado

Para cada chave, o cartão mostra os últimos 4 carateres, quem a criou e quando foi usada pela última vez.

Para especialistas

Enviar a chave

O HolyArrs lê a chave do primeiro sítio onde a encontra, por esta ordem. Uma chave errada num sítio anterior falha, mesmo que uma posterior esteja certa.

Ordem	Sítio	Exemplo
1	Valor de consulta apikey, em maiúsculas ou minúsculas	/sonarr/api/v3/series?apikey=KEY
2	Cabeçalho X-Api-Key	X-Api-Key: KEY
3	Cabeçalho Authorization, com ou sem Bearer	Authorization: Bearer KEY

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

A forma de consulta só é aceite nestes endereços, e o HolyArrs esconde-a no seu próprio registo (log). Um proxy inverso à frente pode registar o endereço completo.

Regras das chaves

• Cada lado tem a sua chave, criada só neste cartão. As chaves de API do HolyArrs (que começam por hak_) não funcionam aqui, e estas chaves não funcionam em mais lado nenhum.
• Uma chave age como a pessoa que a criou, que precisa de permissão para gerir a Biblioteca. O Prowlarr precisa também de permissão para alterar definições.
• Se essa pessoa for desativada ou perder a permissão, as apps são recusadas até alguém criar uma chave nova. O cartão avisa-te.

Gerir com a API do HolyArrs

Com sessão iniciada com a tua palavra-passe. As chamadas de chaves precisam de um início de sessão recente com palavra-passe.

O quê	Chamada
Ler interruptores, endereços e chaves	GET /api/v1/settings/old-app-api
Ativar	PUT /api/v1/settings/old-app-api com {"enabled": true}
Deixar as apps apagar ficheiros	PUT /api/v1/settings/old-app-api com {"delete_files": true}
Criar a chave do lado do Sonarr	POST /api/v1/settings/old-app-api/keys/sonarr
Criar a chave do lado do Radarr	POST /api/v1/settings/old-app-api/keys/radarr
Remover uma chave	DELETE /api/v1/settings/old-app-api/keys/sonarr (ou radarr)

Relacionado

• Clientes da API das apps anteriores
• Limites da API das apps anteriores
• Proxy inverso e URL base