3x-uiمرجع API
REST API پنل 3x-ui — احراز هویت، inboundها، کلاینتها، آمار سرور و موارد دیگر، تولیدشده از مشخصات OpenAPI.
پنل 3x-ui یک REST API برای خودکارسازی در اختیار میگذارد. این صفحات از مشخصات OpenAPI پنل تولید شدهاند، بنابراین همواره با اسکیمای مستندشده هماهنگ هستند.
احراز هویت
درخواستها یا با یک کوکی نشست (از POST /login) یا با یک
توکن Bearer احراز هویت میشوند:
Authorization: Bearer <token>توکنهای API را در پنل بسازید؛ این توکنها اعتبارنامههای ادمین کامل هستند، پس آنها را بهصورت ایمن نگهداری کنید. به توکنهای API مراجعه کنید.
مرور بر اساس حوزه
این مرجع با اجرای pnpm gen:api از public/openapi.json بازتولید میشود.
صفحات تگ تولیدشده را بهصورت دستی ویرایش نکنید.
پورتها و فایروال
پورتهایی که 3x-ui بهصورت پیشفرض استفاده میکند و قواعد آماده ufw / nftables برای باز کردن آنها.
احراز هویت
دو حالت احراز هویت پشتیبانی میشود. نشستهای UI از یک کوکی استفاده میکنند که توسط نقطهپایانی ورود تنظیم میشود. کلاینتهای برنامهنویسیشده (رباتها، اسکریپتها، پنلهای راه دور) با یک توکن Bearer که از مسیر Settings → Security → API Token گرفته میشود احراز هویت میکنند. هر دو روش برای همهٔ نقاطپایانی زیر /panel/api/* کار میکنند.