API ứng dụng cũ

Trỏ một ứng dụng chỉ biết Sonarr hoặc Radarr tới HolyArrs. Đưa cho nó một địa chỉ kết thúc bằng /sonarr hoặc /radarr cùng một khóa, và nó sẽ coi HolyArrs là ứng dụng đó.

Đây là một API nhỏ chỉ làm cho các ứng dụng ấy. Với script của riêng bạn, hãy dùng API HolyArrs.

Bật tính năng

Tính năng này tắt theo mặc định. Khi tắt, mọi địa chỉ dưới /sonarr/ và /radarr/ đều trả về 404.

1. Mở Settings > API (Cài đặt > API).
2. Trên khung Requests from Seerr and Overseerr (yêu cầu từ Seerr và Overseerr), bật Answer Seerr and Overseerr (trả lời Seerr và Overseerr).
3. Nhấn Make key (tạo khóa) cạnh Shows (phim bộ). Đây là khóa phía Sonarr. Hãy chép ngay; khóa chỉ hiện một lần.
4. Nhấn Make key cạnh Movies (phim lẻ). Đây là khóa phía Radarr. Chép luôn khóa này.
5. Ghi lại địa chỉ của mỗi phía trên khung, chẳng hạn /sonarr. Khi có URL base thì khung hiện /holyarrs/sonarr. Hãy dùng đúng những gì khung hiển thị.

Khi tạo khóa, HolyArrs hỏi lại mật khẩu của bạn nếu gần đây bạn chưa đăng nhập bằng mật khẩu. Sau đó thiết lập từng ứng dụng: xem Ứng dụng khách của API ứng dụng cũ.

Chú ý

Seerr lưu khóa dưới dạng văn bản thường trong tệp cài đặt của nó. Vì vậy Let these apps delete files (cho các ứng dụng này xóa tệp) tắt theo mặc định.

Tùy chọn trên khung

Tùy chọn	Tác dụng	Mặc định
Answer Seerr and Overseerr	Bật hoặc tắt /sonarr và /radarr cùng lúc.	Tắt
Make key / New key	Tạo khóa cho phía đó. Khóa mới làm khóa cũ ngừng hoạt động ngay.
Remove key	Xóa khóa của phía đó. Các ứng dụng đang dùng khóa này bị từ chối.
Let these apps delete files	Khi tắt, việc xóa một mục trong ứng dụng sẽ để lại tệp. Khi bật, tệp đi vào thư mục lưu tạm trước, như mọi lần xóa khác của HolyArrs.	Tắt

Với mỗi khóa, khung hiển thị 4 ký tự cuối, người tạo và lần dùng gần nhất.

Dành cho người dùng nâng cao

Gửi khóa

HolyArrs đọc khóa từ nơi đầu tiên nó tìm thấy, theo thứ tự này. Khóa sai ở nơi đứng trước sẽ bị lỗi, dù nơi đứng sau có khóa đúng.

Thứ tự	Nơi	Ví dụ
1	Giá trị truy vấn apikey, không phân biệt hoa thường	/sonarr/api/v3/series?apikey=KEY
2	Header X-Api-Key	X-Api-Key: KEY
3	Header Authorization, có hoặc không có Bearer	Authorization: Bearer KEY

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

Dạng truy vấn chỉ được chấp nhận ở các địa chỉ này, và HolyArrs che nó trong nhật ký của mình. Reverse proxy đứng trước vẫn có thể ghi lại toàn bộ địa chỉ.

Quy tắc về khóa

• Mỗi phía có khóa riêng, chỉ tạo được trên khung này. Khóa API của HolyArrs (bắt đầu bằng hak_) không dùng được ở đây, và các khóa này không dùng được ở bất kỳ nơi nào khác.
• Khóa hoạt động với tư cách người đã tạo nó, người này cần có quyền quản lý Thư viện. Prowlarr còn cần quyền thay đổi cài đặt.
• Nếu người đó bị tắt hoặc mất quyền, các ứng dụng bị từ chối cho đến khi ai đó tạo khóa mới. Khung đó sẽ lưu ý cho bạn.

Quản lý bằng API HolyArrs

Đăng nhập bằng mật khẩu của bạn. Các lệnh gọi về khóa cần một lần đăng nhập bằng mật khẩu gần đây.

Việc cần làm	Lệnh gọi
Đọc công tắc, địa chỉ và khóa	GET /api/v1/settings/old-app-api
Bật tính năng	PUT /api/v1/settings/old-app-api với {"enabled": true}
Cho ứng dụng xóa tệp	PUT /api/v1/settings/old-app-api với {"delete_files": true}
Tạo khóa phía Sonarr	POST /api/v1/settings/old-app-api/keys/sonarr
Tạo khóa phía Radarr	POST /api/v1/settings/old-app-api/keys/radarr
Xóa một khóa	DELETE /api/v1/settings/old-app-api/keys/sonarr (hoặc radarr)

Liên quan

• Ứng dụng khách của API ứng dụng cũ
• Giới hạn của API ứng dụng cũ
• Reverse proxy và URL base