پرش به محتویات

نحوه استفاده از API در پروژه HiddifyManager

پروژه HiddifyManager دو نسخه از API های خود را ارائه می دهد. با این حال، به شدت توصیه می شود از نسخه دو استفاده کنید، زیرا ممکن است نسخه یک در آینده منسوخ شود. این پست وبلاگ قصد دارد شما را در فرآیند استفاده از نسخه دو API راهنمایی کند،

می‌توانید مستندات مربوط به ورژن دو را در پنل ادمین -> تنظیمات -> API بررسی کنید.

احراز هویت API

برای استفاده از APIها، احراز هویت مورد نیاز است، که باید استفاده از UUID ادمین/کاربر (با توجه به API) به عنوان یک کلید استفاده شود.

این کلید باید به عنوان مقدار هدر "Hiddify-API-Key" در درخواست گنجانده شود.

ساختار API نسخه دو

این ساختار به سه بخش اصلی تقسیم می شود: - بخش پنل، این بخش عملیات چنین عملیاتی را ارائه میدهد: - گرفتن نسخه پنل - پینگ با خود پنل (جهت اطمینان از اینکه پنل در حال اجرا است)

شروع URL پایه ی این بخش:

/domain.com/admin_proxy_path/api/v2/panel

  • بخش ادمین، این بخش چنین عملیاتی را ارائه میدهد:
    • گرفتن اطلاعات مربوط به ادمین فعلی (ادمینی که لاگین کرده)
    • مدیریت (دریافت/ایجاد/ویرایش/حذف) ادمین ها
    • دسترسی به آمار سرور فعلی
    • مشاهده محتویات فایل‌های لاگ Hiddify (خروجی HTML است)

شروع URL پایه‌ی این بخش:

/domain.com/admin_proxy_path/api/v2/admin

  • بخش کاربر، این بخش چنین عملیاتی را ارائه می‌دهد:
    • گرفتن به اطلاعات کاربر فعلی (کاربری که لاگین کرده)
    • گرفتن کلاینت‌های پیشنهادی و جزئیات مربوط به آنها
    • گرفتن لینک سابسکریپشن‌های فعال
    • گرفتن لینک پروکسی‌های Mtproto
    • گرفتن لینک موقت (کوتاه) پنل کاربر

      توجه: اگرچه امکان وارد کردن کلید API در قسمت URL وجود دارد، اما توصیه می‌شود آن را در هدر وارد کنید.

      شروع URL پایه ی این بخش، بر اساس اینکه کلید API را در کجا قرار می‌دهید، می‌تواند یکی از این دو باشد:

      domain.com/user_proxy_path/api/v2/user/

      domain.com/user_proxy_path/uuid/api/v2/user/

اطلاعات تکمیلی

برای کسب اطلاعات بیشتر در مورد هر API، ورودی‌ها و خروجی‌های آن، لطفاً به بخش API پنل ادمین خود مراجعه کنید.

در پایان، API نسخه دوم HiddifyManager طیف گسترده ای از ویژگی ها و عملکردها را ارائه می دهد تا مدیریت پنل، ادمین ها، کاربران و موارد دیگر را تا حد امکان یکپارچه و کارآمد کند.

نکته

امکان تغییر endpointها یا input/outpoutها در هر APIی وجود دارد و توسعه‌دهندگان عزیز می‌بایست با آپدیت‌ها و تغییرات هیدیفای‌منیجر، دستورالعمل‌های مربوط به API را مطالعه نمایند.


اخرین بروزرسانی: 30 مهٔ 2024

نظرات