API شرکا
API سرور برای شرکا: کاربر بسازید، طرح اختصاص دهید و اشتراکها را از وبسایت یا ربات خود مدیریت کنید.
API شرکا به شما امکان میدهد وبسایت، پنل مشتری یا ربات خود را روی CreateYourVPN بسازید. این API فقط مشتریان، طرحها و اشتراکها را ارائه میکند؛ سرورها، نودها، پنلها و اطلاعات ورود زیرساخت هرگز در پاسخها نمایش داده نمیشوند.
کلید فقط برای ارتباط سرور با سرور است. کلیدهای API در سرور ذخیره می شوند و در کد مرورگر یا برنامه تلفن همراه گنجانده نمی شوند. درخواست های ارسال شده از یک مرورگر HTTP 403 را برمی گرداند (browser_forbidden).
شروع کار
- در داشبورد تنظیمات ← API و یکپارچهسازیها را باز کنید.
- کلیدی با حداقل دسترسی بسازید و بخش محرمانه را کپی کنید؛ این مقدار فقط یکبار نمایش داده میشود.
- کلید را بهصورت
Authorization: Bearer cyv_live_…یاX-API-Keyبفرستید.
curl https://api.createyourvpn.com/api/v1/partner-api/me \
-H "Authorization: Bearer cyv_live_<key_id>_<secret>"دسترسیها: config:read برای تنظیمات و موقعیتها، users:read برای خواندن مشتریان و users:write برای ساخت مشتری و مدیریت اشتراکها.
قرارداد عمومی
مجموعه عمومی Postman شامل تمام endpointها، پارامترها، bodyها، نمونهها، دسترسیها و کدهای خطا است. این مجموعه از قرارداد backend تولید میشود و تنها مرجع فنی است.
محدودیتها: برای هر کلید ۱۲۰ درخواست در دقیقه و برای GET /users ده درخواست در دقیقه. عملیات grant، rotate و DELETE به Idempotency-Key نیاز دارند؛ برای همه تلاشهای مجدد یک رویداد تا ۲۴ ساعت همان مقدار را استفاده کنید.
بازیابی از یک پشتیبان
دو راه برای بازگرداندن کاربران: بازیابی یککلیکی درون داشبورد که آنها را بهصورت خودتوان دوباره وارد میکند، یا بازیابی دستی در یک Marzban خام، چون فایل در قالب بومی کاربر Marzban است.
دسترسی اضطراری
راهی پشتیبان برای اتصال وقتی شبکه از فهرست سفید استفاده میکند و اتصال اصلی مسدود است — یک تماس تصویری بسازید، پیوند آن را از حساب خود یا با ایمیل به ما بدهید و اتصالی آمادهٔ استفاده بگیرید.