المرجع

مرجع API

أين يعيش مرجع OpenAPI المستضاف، وكيف تصادق، وكيف تبدو كل استجابة، وحدود المعدل.

يُولَّد مرجع Polylane API الكامل من مواصفة OpenAPI التي تقدّمها المنصة، فيطابق دائماً ما هو منشور.

افتح مرجع API

كل عملية وشكل طلب واستجابة، ومقتطفات طلبات قابلة للنسخ.

المصادقة

أرسل مفتاح API لمساحة العمل في الترويسة x-api-key، أو رمز وصول OAuth في Authorization: Bearer. أنشئ أياً منهما في وحدة التحكم؛ انظر مفاتيح API وعملاء OAuth.

Terminal

curl https://api.polylane.com/v1/workspaces \
  -H "x-api-key: $POLYLANE_API_KEY"

صيغة الاستجابة

تستخدم كل استجابة JSON الغلاف نفسه.

الحقل	الوصف
`success`	`true` حين ينجح الطلب، و`false` حين يفشل.
`message`	عند النجاح، كائن يصف `message` فيه الحالة. `null` عند الفشل.
`error`	`null` عند النجاح. عند الفشل، كائن بـ `message` و`detail` اختياري و`metadata` اختيارية.
`result`	الحمولة عند النجاح. غائب عند الفشل.

{
  "success": true,
  "message": { "message": "Successful request" },
  "error": null,
  "result": { "items": [], "count": 0 }
}

حدود المعدل

الواجهة	الحد
REST API	5,000 طلب كل 60 ثانية لكل بيانات اعتماد
خادم MCP الخاص بالمنصة	600 طلب كل 60 ثانية لكل بيانات اعتماد

تعلن الاستجابات السياسة في الترويستين RateLimit-Limit وRateLimit-Policy. وعند تجاوز الحد، تجيب API بـ 429 مع ترويسة Retry-After تحمل النافذة بالثواني؛ تراجع حتى تنقضي، ثم أعد المحاولة.

كل عملية قابلة للاستدعاء أيضاً من CLI، المولَّد من المواصفة نفسها.

مرجع API

المصادقة

صيغة الاستجابة

حدود المعدل

ذات صلة