Pular para o conteúdo

API dos apps anteriores

Especialista

Aponte para o HolyArrs um app que só conhece o Sonarr ou o Radarr. Dê a ele um endereço que termina em /sonarr ou /radarr e uma chave, e ele trata o HolyArrs como esse app.

Esta é uma API pequena, feita só para esses apps. Para seus próprios scripts, use a API do HolyArrs.

Vem desativada por padrão. Enquanto está desativada, todo endereço em /sonarr/ e /radarr/ responde 404.

  1. Abra Settings > API (configurações > API).
  2. No cartão Requests from Seerr and Overseerr (pedidos do Seerr e do Overseerr), ative Answer Seerr and Overseerr (responder ao Seerr e ao Overseerr).
  3. Clique em Make key (criar chave) ao lado de Shows (séries). Esta é a chave do lado Sonarr. Copie agora; ela só aparece uma vez.
  4. Clique em Make key ao lado de Movies (filmes). Esta é a chave do lado Radarr. Copie também.
  5. Anote o endereço de cada lado que o cartão mostra, como /sonarr. Com uma URL base, o cartão mostra /holyarrs/sonarr. Use o que o cartão mostra.

Para criar uma chave, o HolyArrs pede sua senha de novo se você não entrou com ela há pouco tempo. Depois configure cada app: veja Clientes da API dos apps anteriores.

Configurações do cartão

Link para Configurações do cartão
Configuração O que faz Padrão
Answer Seerr and Overseerr Ativa ou desativa /sonarr e /radarr juntos. Desativado
Make key / New key (chave nova) Cria a chave desse lado. Uma chave nova faz a antiga parar na hora.
Remove key (remover chave) Exclui a chave desse lado. Os apps que usam essa chave são recusados.
Let these apps delete files Desativado: remover um título em um app deixa os arquivos. Ativado: os arquivos vão primeiro para a pasta de retenção, como em toda exclusão do HolyArrs. Desativado

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

Como enviar a chave

O HolyArrs lê a chave do primeiro lugar em que a encontra, nesta ordem. Uma chave errada em um lugar anterior falha, mesmo que a de um lugar posterior esteja certa.

Ordem Lugar Exemplo
1 Valor apikey na query, com 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
Terminal window
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

A forma pela query só é aceita nesses endereços, e o HolyArrs esconde a chave no próprio log. Um proxy reverso na frente ainda pode registrar o endereço completo no log dele.

Regras das chaves
  • Cada lado tem sua própria chave, criada só neste cartão. As chaves de API do HolyArrs (que começam com hak_) não funcionam aqui, e estas chaves não funcionam em nenhum outro lugar.
  • Uma chave age como a pessoa que a criou, que precisa de permissão para gerenciar a Biblioteca. O Prowlarr também precisa de permissão para mudar configurações.
  • Se essa pessoa for desativada ou perder a permissão, os apps são recusados até alguém criar uma chave nova. O cartão avisa você.
Gerencie pela API do HolyArrs

Com login feito com sua senha. As chamadas de chave precisam de um login recente com senha.

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

O HolyArrs é gratuito. Se ele poupou seu tempo, dê uma estrela no GitHub, patrocine o projeto ou me pague um café.