راهنمای REST API
نشانی پایه: /api
ورود با شماره همراه و کد پیامکی انجام می‌شود. برای اتصال برنامه، هنگام تأیید کد مقدار issue_token: true ارسال کنید؛ سپس توکن را در هدر Authorization: Bearer TOKEN قرار دهید. توکن در بخش «دسترسی API» هم قابل ساخت و لغو است.
توکن مانند دسترسی حساب شماست. اطلاعات اتصال را فقط در برنامه مورد اعتماد استفاده کنید.
POST /api/auth/send-otp
{"phone":"09121234567"}
POST /api/auth/verify-otp
{"phone":"09121234567","code":"123456","issue_token":true}
GET /api/subscriptions
Authorization: Bearer TOKENمسیرها
| روش | مسیر | کاربرد |
|---|---|---|
| GET | /plans | پلن‌های فعال |
| GET | /me | حساب فعلی |
| GET / POST | /orders | سفارش‌ها / ثبت خرید یا تمدید |
| PATCH | /orders/{id} | لغو سفارش در انتظار تأیید |
| GET | /subscriptions | اشتراک‌های مشتری |
| PATCH | /subscriptions/{id} | لغو اشتراک خود |
| POST | /subscriptions/{id}/sync | استعلام مصرف و وضعیت واقعی |
| GET | /subscriptions/{id}/connection | لینک اشتراک تأییدشده |
| GET | /subscriptions/{id}/config | دانلود کانفیگ واقعی |
| GET / POST | /tickets | تیکت‌ها / تیکت جدید |
| GET / PATCH | /tickets/{id} | مشاهده / باز و بسته کردن |
| POST | /tickets/{id}/messages | پاسخ به تیکت |
| GET / POST | /tokens | توکن‌ها / ایجاد توکن |
| DELETE | /tokens/{id} | لغو توکن |
| GET | /admin/overview | آمار مدیر |
| GET / POST | /admin/plans | فهرست و ساخت پلن |
| PATCH | /admin/plans/{id} | ویرایش یا غیرفعال‌کردن پلن |
| GET | /admin/orders | همه سفارش‌ها |
| PATCH | /admin/orders/{id} | تأیید دستی یا رد سفارش |
| GET / PATCH | /admin/subscriptions[/{id}] | اشتراک‌ها / مصرف و اتصال |
| GET / PATCH | /admin/users[/{id}] | مدیریت کاربران |
| GET | /admin/tickets | تیکت‌های مشتریان |
| GET / POST / PATCH | /admin/discounts[/{id}] | تخفیف‌ها |
| GET | /admin/audit | گزارش تغییرات |
| GET | /admin/service | وضعیت تنظیمات و صف |
| POST | /admin/service/check | بررسی فقط خواندنی اتصال |
| GET | /admin/service/jobs | صفحه‌بندی عملیات سرویس |
| POST | /admin/service/run | پردازش یک عملیات |
| POST | /admin/service/jobs/{id}/retry | تلاش دوبارهٔ عملیات ناموفق |
| POST | /auth/logout | خروج و لغو توکن جاری |
جزئیات بدنه‌ها، محدودیت‌ها و نمونه‌ها در فایل docs/API.md بستهٔ پروژه موجود است. تاریخ API به UTC، قیمت به تومان و حجم به گیگابایت است. سفارش به‌صورت در انتظار تأیید ثبت می‌شود؛ تأیید مدیر عملیات واقعی پاسارگارد را در صف قرار می‌دهد؛ اطلاعات اتصال پس از پاسخ موفق پنل ارائه می‌شوند. پیامک و درگاه پرداخت فعلاً به تعویق افتاده‌اند. فهرست‌ها limit و offset و نشانگر pagination.has_more دارند.