مرجع API
هر نقطهٔ مستندشده در یکی از این صفحه‌هاست، گروه‌بندی‌شده بر اساس چیزی که رویش کار می‌کند. هر نقطه روش و مسیر، دسترسی لازم، اینکه توکن می‌تواند صدایش بزند یا نه، پارامترها و بدنه، یک مثال curl و یک مثال پاسخ دارد.
نمونهٔ پاسخ‌ها فقط فیلدهای منتخب را نشان می‌دهد؛ ساختار کامل پاسخ در سند OpenAPI آمده است.
ترافیک با بایت است. زمان با ثانیهٔ یونیکس است. سقف ترافیک 0 یعنی بی‌نهایت و تاریخ پایان 0 یعنی هرگز.
هر نقطه را چطور بخوانیم
/api/clientsدسترسیclients.create- روش و مسیر همان مسیر سند است. در مثال‌ها
$BASEخودش به/apiختم می‌شود، پس$BASE/clientsهمان<panel-base>/api/clientsاست. - دسترسی همان دسترسی‌ای است که حساب لازم دارد. توکن سفارشی هم باید آن را داشته باشد.
anyیعنی هر حساب واردشده،staffیعنی مالک یا حسابی باclients.viewبرای همهٔ کاربران، وpublicیعنی بدون هیچ ورود. - فقط نشست یعنی درخواست توکن با
403وtoken_forbiddenرد می‌شود؛ از نشست مرورگر استفاده کنید. - توکنی که دسترسی را دارد می‌تواند نقطه را صدا بزند، مگر اینکه فقط نشست نوشته باشد. مسیرهای مخصوص مالک، توکن سفارشی را هم رد می‌کنند، حتی اگر مالک آن را ساخته باشد.
پارامترهای مسیر داخل آکولاد هستند، مثلاً {id}. پارامترهای query بعد از ? می‌آیند و تا جدول نگوید لازم‌اند، اختیاری‌اند. بدنهٔ درخواست JSON است، مگر نقطه بگوید multipart یا باینری.
گروه‌ها
| صفحه | چه چیزی را پوشش می‌دهد |
|---|---|
| کاربران | کاربران، ساخت و کارهای گروهی، مصرف، پروفایل، کد QR و دستگاه‌های WireGuard. |
| اتصال‌ها | اتصال‌های زنده، تاریخچه و بستن یکی. |
| اینباندها | اینباندها، پیش‌فرض‌ها، پیش‌بررسی، استقرار، بازنویسی، کنترل و گزارش. |
| گروه‌ها | گروه‌ها، کارهای گروهی و تخصیص گروه به کاربران. |
| نودها | نودها، نصب، کارها، پروتکل‌ها و حذف بسته. |
| حساب‌ها و نقش‌ها | حساب‌های پنل، نقش‌ها، کارهای طرح و مصرف هر حساب. |
| تنظیمات پنل | نمای کلی، سیستم، تنظیمات، TLS، پشتیبان، پشتیبان Telegram، به‌روزرسانی و گزارش فعالیت. |
| ورود و حساب | اطلاعات پنل، ورود، حساب شما، نشست‌ها و توکن‌ها. |
| لینک‌های اشتراک | صفحه‌ها و فایل‌های عمومی پشت لینک اشتراک یک کاربر. |
پاسخ‌های مشترک
| وضعیت | بدنه |
|---|---|
| موفق با داده | یک شیء یا آرایهٔ JSON. |
204 | بدون بدنه. |
| خطا | { "error": "...", "code": "...", "field": "...", "params": {...} }، با code و field فقط وقتی کاربرد دارند. |
فهرست‌های GET رکوردهایی را برمی‌گردانند که حساب می‌بیند. نماینده کاربران خودش را می‌بیند و فقط گروه‌ها و اینباندهایی را که به او داده شده.
شناسهٔ نود 0 همان سرور پنل است. اینباندی با nodeId: -1 هنوز به نودی تخصیص نیافته.
صفحه‌های مرتبط
- نمای کلی API: آدرس پایه، توکن‌ها و کدهای خطا.
- توکن‌های API: فهرست دسترسی‌ها.
- سند OpenAPI: آوردن در ابزار یا ساخت کلاینت.