跳转到内容

旧应用 API

进阶

把只认识 Sonarr 或 Radarr 的应用指向 HolyArrs。给它一个以 /sonarr 或 /radarr 结尾的地址和一个密钥,它就会把 HolyArrs 当成那个应用。

这是一套只为这些应用做的小型 API。你自己的脚本请用 HolyArrs API。

默认是关着的。关着的时候,/sonarr/ 和 /radarr/ 下的所有地址都返回 404。

  1. 打开 Settings > API(设置 > API)。
  2. 在 Requests from Seerr and Overseerr(来自 Seerr 和 Overseerr 的请求)卡片上,打开 Answer Seerr and Overseerr(响应 Seerr 和 Overseerr)。
  3. 点击 Shows(剧集)旁边的 Make key(生成密钥)。这是 Sonarr 侧密钥。马上复制,它只显示一次。
  4. 点击 Movies(电影)旁边的 Make key。这是 Radarr 侧密钥。也复制下来。
  5. 记下卡片上每一侧的地址,比如 /sonarr。设了 URL 基础路径时会显示 /holyarrs/sonarr。以卡片显示的为准。

如果你最近没有用密码登录过,生成密钥时会再问一次密码。然后逐个设置应用:见旧应用 API 客户端。

卡片上的设置项

卡片上的设置项 的链接
设置项 作用 默认
Answer Seerr and Overseerr 同时打开或关闭 /sonarr 和 /radarr。 关
Make key / New key(新密钥) 生成那一侧的密钥。新密钥一生成,旧密钥立刻失效。
Remove key(移除密钥) 删除那一侧的密钥。用它的应用会被拒绝。
Let these apps delete files 关着时,在应用里移除条目会留下文件。打开时,文件先进暂存文件夹,和 HolyArrs 的每次删除一样。 关

卡片会显示每个密钥的最后 4 个字符、谁生成的,以及上次使用的时间。

发送密钥

HolyArrs 按下面的顺序,从第一个找到密钥的位置读取。靠前的位置里密钥不对就会失败,哪怕靠后的位置里是对的。

顺序 位置 示例
1 apikey 查询参数,大小写不限 /sonarr/api/v3/series?apikey=KEY
2 X-Api-Key 请求头 X-Api-Key: KEY
3 Authorization 请求头,带不带 Bearer 都行 Authorization: Bearer KEY
Terminal window
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

查询参数的写法只在这些地址上接受,HolyArrs 会在自己的日志里把它隐去。前面的反向代理仍可能记录完整地址。

密钥规则
  • 每一侧有自己的密钥,只能在这张卡片上生成。HolyArrs API 密钥(以 hak_ 开头)在这里不能用,这里的密钥在别处也不能用。
  • 密钥以生成它的人的身份行事,这个人需要有管理媒体库的权限。Prowlarr 还需要改设置的权限。
  • 如果这个人被停用或失去了权限,应用会被拒绝,直到有人生成新密钥。卡片会提醒你。
用 HolyArrs API 管理

需要用密码登录。和密钥有关的调用需要最近用密码登录过。

做什么 调用
读取开关、地址和密钥 GET /api/v1/settings/old-app-api
打开它 PUT /api/v1/settings/old-app-api,带上 {"enabled": true}
允许应用删除文件 PUT /api/v1/settings/old-app-api,带上 {"delete_files": true}
生成 Sonarr 侧密钥 POST /api/v1/settings/old-app-api/keys/sonarr
生成 Radarr 侧密钥 POST /api/v1/settings/old-app-api/keys/radarr
移除一个密钥 DELETE /api/v1/settings/old-app-api/keys/sonarr(或 radarr)

HolyArrs 是免费的。如果它帮你省了时间,欢迎在 GitHub 上点个 Star、赞助它或请我喝杯咖啡。