در بخش 🤝 نمایندگی روی 📚 مستندات API بزنید. مستندات روی سایت خود پنل نمایندگی، در مسیر /docs قرار دارد و عمومی است: برای خواندن آن لازم نیست وارد شوید. زبان مستندات انگلیسی است.
راههای دیگر
- در مرورگر،
/docsرا به انتهای نشانی پنل نمایندگی اضافه کنید. - روی صفحهنمایش بزرگ، مثل کامپیوتر، صفحهٔ ورود پنل هم پیوند Read the API reference → را به مستندات دارد.
- اگر در ربات نه 📚 مستندات API را میبینید و نه 🖥 ورود به پنل را، نشانی را از پشتیبانی بپرسید.
چه چیزهایی در آن هست
- راهنماها: Authentication (کلیدها، بستن کلید به IP و اینکه چرا کلاینت شما باید از IPv4 استفاده کند، مدت اعتبار)، Idempotency، Pagination، Errors، Rate limits و Webhooks (بررسی امضا، تلاشهای دوباره، فهرست رویدادها).
- مرجع API: همهٔ مسیرها، فیلدهای درخواست و پاسخ و کدهای خطایی که هر مسیر ممکن است برگرداند.
پیش از شروع بدانید
- پنل و API روی یک حساب نمایندگی کار میکنند، با همان قیمتها و همان سقفها. سروری که از طریق API سفارش دهید در پنل هم دیده میشود.
- سفارش بهصورت ناهمگام انجام میشود: هزینه هنگام پذیرش سفارش از کیف پول کسر میشود و سرور کمی بعد آماده میشود. بهجای پرسوجوی پشتسرهم، منتظر رویداد server.active بمانید.
- مسیرهایی که سفارش، خرید، تغییر پلن، نصب مجدد یا حذف انجام میدهند به
Idempotency-Keyنیاز دارند. تلاش دوباره با همان کلید، پاسخ اول را برمیگرداند و سفارش دومی ثبت نمیشود. - تصمیمگیری را بر اساس
codeخطا انجام دهید، نه متن پیام: متن ممکن است تغییر کند، اما کد تغییر نمیکند. - بهمرور فیلدها و رویدادهای جدید اضافه میشوند، پس نرمافزار شما باید هر چیزی را که نمیشناسد نادیده بگیرد.
اگر مشکل حل نشد
اگر مستندات باز نمیشود، به پشتیبانی پیام دهید و نشانیای که باز کردید و آنچه دیدید را بنویسید.