مستندات API VPS.org

شروع به کار

رابط برنامه‌نویسی کاربردی VPS.org به شما امکان می‌دهد تا تمام جنبه‌های زیرساخت میزبانی VPS خود، از جمله سرورها، دامنه‌ها، رکوردهای DNS، پشتیبان‌گیری‌ها و اسنپ‌شات‌ها را به صورت برنامه‌نویسی مدیریت کنید.

احراز هویت

همه درخواست‌های API نیاز به احراز هویت با استفاده از توکن Bearer دارند. می‌توانید توکن API خود را از تنظیمات حساب کاربری خود در آدرس زیر ایجاد کنید. admin.vps.org/account/developers/.

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

محدود کردن نرخ

درخواست‌های API به ۳۰۰ درخواست در هر ۵ دقیقه به ازای هر توکن API محدود شده‌اند. اطلاعات محدودیت سرعت در هدرهای پاسخ گنجانده شده است:

• X-RateLimit-Limit: حداکثر تعداد درخواست‌های مجاز
• X-RateLimit-Remaining: تعداد درخواست‌های باقی‌مانده
• X-RateLimit-Reset: مهر زمانی که محدودیت نرخ مجدداً تنظیم می‌شود

مدیریت خطا

این API از کدهای وضعیت استاندارد HTTP برای نشان دادن موفقیت یا شکست استفاده می‌کند:

دسته بندی های API

مستندات API ما را بر اساس دسته‌بندی مرور کنید:

به کمک نیاز دارید؟

اگر سوالی دارید یا در مورد API به کمک نیاز دارید، لطفاً دریغ نکنید با ما تماس بگیرید:

• تیکت‌های پشتیبانی: یک تیکت پشتیبانی باز کنید
• ایمیل: support@vps.org
• مستندات: مستندات کامل