VPS.org وثائق البرنامج المتقدم للاختبارات

ابدء

تتيح لك واجهة برمجة التطبيقات VPS.org إدارة جميع جوانب البنية التحتية لاستضافة VPS الخاصة بك برمجيًا، بما في ذلك الخوادم والنطاقات وسجلات DNS والنسخ الاحتياطية واللقطات.

المصادقة

تتطلب جميع طلبات واجهة برمجة التطبيقات (API) المصادقة باستخدام رمز حامل (Bearer token). يمكنك إنشاء رمز واجهة برمجة التطبيقات الخاص بك من إعدادات حسابك على 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);

كل رمز يحمل تصاريحه الخاصة، مثل servers:list أو dns:*. الطلب الذي يحتاج إلى تصريح لا يملكه الرمز يرفض مع 403 و required_permission field تسمية التصريح المفقود. الإذن المرجع

تحديد معدل الاستخدام

الطلبات المصدق عليها محدودة بـ 1000 في الساعة لكل حساب. الطلبات غير المصدق عليها محدودة بـ 100 في الساعة لكل عنوان IP. الطلب الذي يتجاوز الحد يتلقى 429 مع عنوان Retry-After يعطي عدد الثواني للانتظار. لا ترسل عناوين الحد من المعدل على الاستجابات الناجحة.

الصفحات

قائمة نقاط نهاية تعيد كائن مع العدد، التالي، السابق والنتائج، 25 مادة في كل صفحة. صفحة مرور للتحرك بين الصفحات، أو تتبع العنوان التالي حتى يكون صفرا. قائمة الخوادم أيضا تقبل page_size، حتى 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

معالجة الأخطاء

تستخدم واجهة برمجة التطبيقات رموز حالة HTTP القياسية للإشارة إلى النجاح أو الفشل:

معظمها لديه حقل تفاصيل أو حقل خطأ، أحيانا مع رسالة؛ أخطاء التحقق تبين المشاكل حسب اسم الحقل.

فئات واجهة برمجة التطبيقات

تصفح وثائق واجهة برمجة التطبيقات (API) الخاصة بنا حسب الفئة:

نقاط نهاية إضافية

ويتضمن برنامج التطبيقات أيضا نقاطا نهائية لنشر التطبيقات (/api/v1/deploy-configs/ و /api/v1/deployments/) وهي غير موصوفة في هذه الصفحات بعد؛ وتورد المراجع التفاعلية قائمة بكل نقطة نهائية، مولدة من برنامج التطبيقات الحي.

هل تحتاج إلى مساعدة؟

إذا كانت لديك أسئلة أو كنت بحاجة إلى مساعدة بخصوص واجهة برمجة التطبيقات (API)، فلا تتردد في التواصل معنا:

• تذاكر الدعم: افتح تذكرة دعم
• بريد إلكتروني: hello@vps.org
• الوثائق: الوثائق الكاملة