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

تُعيد كل نقاط النهاية 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 أو cancel (في نهاية فترة الفوترة) أو cancel_revoke.
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_.-]). ويرتبط هذا المفتاح بالطريقة والمسار والجسم. فإذا كررت الطلب نفسه بالمفتاح نفسه خلال ساعة واحدة، فستحصل على الاستجابة المخزّنة؛ وبعد ذلك ستتلقى الرمز 410 مع reason بقيمة replay_stale، وعليك حينها إرسال مفتاح جديد. أما استخدام المفتاح نفسه مع جسم مختلف أو على نقطة نهاية أخرى فيُرفَض بالرمز 409 idempotency_conflict.

حدود المعدل

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