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 | ערך apikey בשאילתה, באותיות כלשהן |
/sonarr/api/v3/series?apikey=KEY |
| 2 | כותרת X-Api-Key |
X-Api-Key: KEY |
| 3 | כותרת Authorization, עם Bearer או בלעדיו |
Authorization: Bearer KEY |
curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/statusצורת השאילתה מתקבלת רק בכתובות האלה, ו-HolyArrs מסתיר אותה בלוג שלו. 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, תמוך בפרויקט או קנה לי קפה.