تُعيد كل نقاط النهاية application/json. تتبع الأخطاء RFC 7807 (Problem+JSON). كل استجابة تحمل ترويسة X-Request-Id للربط مع سجل التدقيق على الخادم.
| Method | Path | النطاق | الغرض |
|---|---|---|---|
| GET | /v1/health | public | فحص صحة بلا مصادقة. |
| GET | /v1/me | any | معلومات حسابك مع بيانات وصفية لمفتاح API. |
| GET | /v1/products | read:products | قائمة بكل المنتجات المدرجة علناً مع الأسعار. |
| GET | /v1/products/{id} | read:products | تفاصيل المنتج بما فيها خيارات التكوين. |
| POST | /v1/orders | write:orders | إنشاء طلبية. Idempotency-Key مطلوب. |
| GET | /v1/orders/{id} | read:orders | حالة طلبيتك. |
| GET | /v1/services | read:services | قائمة بخدماتك (بصفحات). |
| GET | /v1/services/{id} | read:services | تفاصيل خدمة من خدماتك. |
| GET | /v1/services/{id}/credentials | read:credentials | بيانات اعتماد الخدمة (نطاق منفصل، مُسجَّل في التدقيق). |
| POST | /v1/services/{id}/actions | write:services | إجراء على الخدمة: start، stop، reboot، reinstall، suspend، unsuspend، terminate. |
| GET | /v1/billing/balance | read:billing | الرصيد. |
| GET | /v1/billing/invoices | read:billing | قائمة فواتيرك (بصفحات). |
| GET | /v1/billing/invoices/{id}/pdf | read:billing | ملف PDF للفاتورة. |
| GET | /v1/webhooks | read:webhooks | عنوان Webhook الحالي. |
| PUT | /v1/webhooks | write: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 الحالة الراهنة.

