مرجع API

Proxynet API به شما امکان می‌دهد سرویس‌های پروکسی سازمان خود را از سیستم خودتان بخوانید، سفارش جدید ثبت کنید و سرویس‌های موجود را مدیریت کنید. همه درخواست‌ها و پاسخ‌هاJSON هستند و احراز هویت با یک توکن Bearer انجام می‌شود.

آدرس پایه

https://api.proxynet.io/api/v1

در همه فراخوانی‌های سرور به سرور از این آدرس استفاده کنید. آدرس پنل (app.proxynet.io) پشت محافظت Cloudflare است و ممکن است برای درخواست‌هایی که از برخی IPهای سرور می‌آیند، تأیید مرورگر اعمال کند؛ api.proxynet.io فقط API را ارائه می‌دهد و چنین تأییدی انجام نمی‌دهد. توکن و مسیرها در هر دو یکسان‌اند.

احراز هویت

هدر Authorization را به هر درخواست اضافه کنید. کوکی پذیرفته نمی‌شود و توکن را نمی‌توان در نوار آدرس فرستاد.

curl -H "Authorization: Bearer pxn_live_…" \
  https://api.proxynet.io/api/v1/me

برای ساختن توکن و مجوزها، صفحه‌های احراز هویت و توکن‌ها و مجوزها را ببینید.

قالب پاسخ

پاسخ‌های موفق داده را زیر data برمی‌گردانند؛ فهرست‌ها اطلاعات صفحه‌بندی را زیر meta دارند.

{
  "data": [ … ],
  "meta": { "total": 6, "limit": 25, "offset": 0, "has_more": false }
}

خطاها در همه نقطه‌های پایانی با یک قالب برمی‌گردند؛ منطق برنامه را بر اساس فیلد code بنویسید، نه متن پیام. فهرست کامل کدها در صفحه خطاها آمده است.

نقطه‌های پایانی

نقطه‌های پایانی به ترتیب چرخه عمر یک سفارش چیده شده‌اند: ابتدا در کاتالوگ ببینید چه چیزی می‌توانید بخرید، سپس سفارش ثبت کنید و سرویس ایجادشده را ازصفحه‌های محصول آن زیر نظر بگیرید.

سازمان

• GET/meاطلاعات توکن و سازمان · اعتبار توکن، مجوزهای آن، سازمانی که به آن تعلق دارد، پلن، موجودی حساب و محدودیت درخواست را برمی‌گرداند.

کاتالوگ و قیمت

• GET/catalogکاتالوگ · هر چیزی را که قابل خرید است، با قیمت‌های مطابق پلن شما، در یک پاسخ برمی‌گرداند.
• GET/locationsموقعیت‌ها · موقعیت‌های قابل انتخاب و موجودی لحظه‌ای را برمی‌گرداند.
• GET/target-urlsدامنه‌های هدف · دامنه‌هایی را که در حالت هدفمند قابل انتخاب‌اند برمی‌گرداند.
• GET/stockبررسی موجودی · همان بررسی موجودی‌ای را اجرا می‌کند که هنگام ایجاد سفارش انجام می‌شود.
• GET/pricingاستعلام قیمت · مبلغی را که برای یک نوع، تعداد و گزینه‌های اضافی کسر خواهد شد محاسبه می‌کند.

سفارش‌ها

• GET/ordersفهرست سفارش‌ها · سرویس‌های پروکسی سازمان را فهرست می‌کند؛ هر پنج نوع با هم برمی‌گردند.
• POST/ordersایجاد سفارش · همان سفارشی را ثبت می‌کند که از پنل داده می‌شود و هزینه را از موجودی حساب شما کسر می‌کند.
• GET/orders/{id}جزئیات سفارش · وضعیت، روزهای باقی‌مانده و شمارنده‌های مصرف یک سرویس را برمی‌گرداند.

نقطه‌های پایانی به تفکیک محصول

مسیرها در همه محصولات یکسان‌اند (/orders/…)؛ صفحه‌های محصول، بدنه و نمونه‌ها را به فیلدهای همان محصول محدود می‌کنند. برای رفتن به همین عملیات در محصولی دیگر، از منوی کناری استفاده کنید.

در محصولات به‌ازای هر IP، موقعیت و تعداد انتخاب می‌شود و سرویس در دوره‌های 30 روزه تمدید می‌شود؛ در محصولات به‌ازای هر گیگابایت یک آدرس گیت‌وی واحد وجود دارد، هدف‌گیری کشور/شهر با سازنده نقطه اتصال انجام می‌شود و هزینه مصرف به‌ازای هر گیگابایت از موجودی حساب کسر می‌شود.