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) را روشن کنید.
کنار Shows (سریال‌ها) روی Make key (ساخت کلید) کلیک کنید. این کلید سمت Sonarr است. همین حالا آن را کپی کنید؛ فقط یک بار نشان داده می‌شود.
کنار Movies (فیلم‌ها) روی Make key کلیک کنید. این کلید سمت 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	سرآیند `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

شکل query فقط روی همین نشانی‌ها قبول می‌شود و HolyArrs آن را در لاگ خودش پنهان می‌کند. ریورس پراکسی‌ای که جلوی آن است ممکن است باز هم نشانی کامل را لاگ کند.

قواعد کلید

هر سمت کلید خودش را دارد که فقط در همین کارت ساخته می‌شود. کلیدهای 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 /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 به آن ستاره بدهید، حمایت مالی کنید یا برای من یک قهوه بخرید.