API แอปรุ่นเดิม
ผู้เชี่ยวชาญ
ชี้แอปที่รู้จักแค่ Sonarr หรือ Radarr มาที่ HolyArrs ให้ที่อยู่ที่ลงท้ายด้วย /sonarr หรือ /radarr กับคีย์ แล้วมันจะมอง HolyArrs เป็นแอปนั้น
นี่คือ API ขนาดเล็กที่ทำมาเพื่อแอปเหล่านี้เท่านั้น ถ้าเป็นสคริปต์ของคุณเอง ให้ใช้ API ของ HolyArrs
เปิดใช้งาน
ลิงก์ไปยัง เปิดใช้งานปิดอยู่โดยค่าเริ่มต้น ตอนที่ปิด ทุกที่อยู่ใต้ /sonarr/ และ /radarr/ จะตอบ 404
- เปิด Settings > API (การตั้งค่า > API)
- ที่การ์ด Requests from Seerr and Overseerr (คำขอจาก Seerr และ Overseerr) เปิดสวิตช์ Answer Seerr and Overseerr (ตอบ Seerr และ Overseerr)
- กด Make key (สร้างคีย์) ข้าง Shows (ซีรีส์) นี่คือคีย์ฝั่ง Sonarr คัดลอกไว้เลย เพราะแสดงครั้งเดียว
- กด Make key ข้าง Movies (ภาพยนตร์) นี่คือคีย์ฝั่ง Radarr คัดลอกไว้ด้วย
- จดที่อยู่ของแต่ละฝั่งบนการ์ด เช่น
/sonarrถ้ามี URL base จะแสดงเป็น/holyarrs/sonarrให้ใช้ตามที่การ์ดแสดง
การสร้างคีย์จะขอรหัสผ่านของคุณอีกครั้ง ถ้าคุณไม่ได้ล็อกอินด้วยรหัสผ่านเมื่อไม่นานมานี้ จากนั้นตั้งค่าแต่ละแอป ดูที่ ไคลเอนต์ API แอปรุ่นเดิม
การตั้งค่าบนการ์ด
ลิงก์ไปยัง การตั้งค่าบนการ์ด| ค่าที่ตั้ง | หน้าที่ | ค่าเริ่มต้น |
|---|---|---|
| Answer Seerr and Overseerr | เปิดหรือปิด /sonarr และ /radarr พร้อมกัน |
ปิด |
| Make key / New key (คีย์ใหม่) | สร้างคีย์ของฝั่งนั้น คีย์ใหม่จะทำให้คีย์เก่าใช้ไม่ได้ทันที | |
| Remove key (ลบคีย์) | ลบคีย์ของฝั่งนั้น แอปที่ใช้คีย์นี้จะถูกปฏิเสธ | |
| Let these apps delete files | ตอนปิด การเอารายการออกในแอปจะไม่ลบไฟล์ ตอนเปิด ไฟล์จะไปอยู่ในโฟลเดอร์พักก่อน เหมือนทุกการลบของ HolyArrs | ปิด |
การ์ดแสดงอักขระ 4 ตัวสุดท้ายของแต่ละคีย์ ผู้สร้าง และเวลาที่ใช้ล่าสุด
สำหรับผู้เชี่ยวชาญ
ลิงก์ไปยัง สำหรับผู้เชี่ยวชาญการส่งคีย์
HolyArrs อ่านคีย์จากที่แรกที่พบ ตามลำดับนี้ ถ้าคีย์ผิดในที่ที่มาก่อน จะล้มเหลว แม้ที่หลังจะถูกต้อง
| ลำดับ | ตำแหน่ง | ตัวอย่าง |
|---|---|---|
| 1 | ค่า query apikey ตัวพิมพ์ใหญ่เล็กก็ได้ |
/sonarr/api/v3/series?apikey=KEY |
| 2 | header X-Api-Key |
X-Api-Key: KEY |
| 3 | header Authorization จะมี Bearer หรือไม่ก็ได้ |
Authorization: Bearer KEY |
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/statusรูปแบบ query รับเฉพาะที่อยู่เหล่านี้ และ HolyArrs ซ่อนมันใน Log ของตัวเอง แต่ Reverse proxy ที่อยู่ด้านหน้าอาจยังบันทึกที่อยู่เต็ม
กฎของคีย์
- แต่ละฝั่งมีคีย์ของตัวเอง สร้างได้ที่การ์ดนี้เท่านั้น คีย์ API ของ HolyArrs (ขึ้นต้นด้วย
hak_) ใช้ตรงนี้ไม่ได้ และคีย์เหล่านี้ก็ใช้ที่อื่นไม่ได้ - คีย์ทำงานในนามคนที่สร้าง ซึ่งต้องมีสิทธิ์จัดการคลัง Prowlarr ต้องมีสิทธิ์เปลี่ยนการตั้งค่าด้วย
- ถ้าคนนั้นถูกปิดใช้งานหรือเสียสิทธิ์ แอปจะถูกปฏิเสธจนกว่าจะมีคนสร้างคีย์ใหม่ การ์ดจะเตือนคุณ
จัดการด้วย API ของ HolyArrs
ล็อกอินด้วยรหัสผ่านของคุณ การเรียกเกี่ยวกับคีย์ต้องล็อกอินด้วยรหัสผ่านเมื่อไม่นานมานี้
| สิ่งที่ทำ | การเรียก |
|---|---|
| อ่านสวิตช์ ที่อยู่ และคีย์ | 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 / |
| สร้างคีย์ฝั่ง Radarr | POST / |
| ลบคีย์ | DELETE / (หรือ radarr) |
หน้าที่เกี่ยวข้อง
ลิงก์ไปยัง หน้าที่เกี่ยวข้องHolyArrs ใช้ได้ฟรี ถ้าช่วยประหยัดเวลาคุณได้ กดดาวบน GitHub, สนับสนุนโปรเจกต์ หรือ เลี้ยงกาแฟผู้พัฒนา