مرجع نقاط النهاية

واجهة برمجة الموزعين

تُعيد كل نقاط النهاية application/json. تتبع الأخطاء RFC 7807 (Problem+JSON). كل استجابة تحمل ترويسة X-Request-Id للربط مع سجل التدقيق على الخادم.

MethodPathالنطاقالغرض
GET/v1/healthpublicفحص صحة بلا مصادقة.
GET/v1/meanyمعلومات حسابك مع بيانات وصفية لمفتاح API.
GET/v1/productsread:productsقائمة بكل المنتجات المدرجة علناً مع الأسعار.
GET/v1/products/{id}read:productsتفاصيل المنتج بما فيها خيارات التكوين.
POST/v1/orderswrite:ordersإنشاء طلبية. Idempotency-Key مطلوب.
GET/v1/orders/{id}read:ordersحالة طلبيتك.
GET/v1/servicesread:servicesقائمة بخدماتك (بصفحات).
GET/v1/services/{id}read:servicesتفاصيل خدمة من خدماتك.
GET/v1/services/{id}/credentialsread:credentialsبيانات اعتماد الخدمة (نطاق منفصل، مُسجَّل في التدقيق).
POST/v1/services/{id}/actionswrite:servicesإجراء على الخدمة: start، stop، reboot، reinstall، suspend، unsuspend، terminate.
GET/v1/billing/balanceread:billingالرصيد.
GET/v1/billing/invoicesread:billingقائمة فواتيرك (بصفحات).
GET/v1/billing/invoices/{id}/pdfread:billingملف PDF للفاتورة.
GET/v1/webhooksread:webhooksعنوان Webhook الحالي.
PUT/v1/webhookswrite:webhooksتعيين أو إزالة عنوان Webhook.

عَدَمية الأثر

يتطلب POST /v1/orders وPOST /v1/services/{id}/actions ترويسة Idempotency-Key (1-80 حرفاً من [A-Za-z0-9_.-]). يخزّن الخادم الاستجابة وتجزئة الجسم لمدة 24 ساعة؛ الطلب الثاني بنفس المفتاح ونفس الجسم يُعيد نفس الاستجابة، أما الطلب الثاني بنفس المفتاح وجسم مختلف فيُرفَض بـ 409 idempotency_conflict.

حدود المعدل

الافتراضي: 60 طلباً/دقيقة (مع دفعة 20) و5000/يوم لكل مفتاح API، بالإضافة إلى 600 طلب/دقيقة لكل عنوان IP بصرف النظر عن المفتاح. عند التجاوز يُرَد HTTP 429 مع ترويسة Retry-After. تكشف ترويستا الاستجابة X-RateLimit-Remaining وX-RateLimit-Reset الحالة الراهنة.