مرجع المطوّر وحدود العقود

قبل تنفيذ عميل

تستدعي الواجهة API لوحة التحكم المقيّدة بالنشاط وتعرض إعداد التكاملات. تثبت الاستدعاءات سلوك الواجهة ولا تعني أن مفتاح تكامل خارجي يستطيع استدعاء كل نقطة. احصل على عقد الخادم الخارجي قبل إطلاق عميل خادم إلى خادم.

البيانات الوصفية المستخدمة في اللوحة

المسارات التالية موجودة في عميل الواجهة وهي نسبية لعنوان API المهيأ في بيئتك بما فيه بادئة الإصدار. يتطلب الوصول التفويض الذي يدعمه الخادم للعملية.

يستهلك العميل بيانات أسماء العرض والأوصاف وطرق المصادقة من استجابة الأنواع. تُشتق اختيارات النطاقات والأحداث من استجابتيهما. استخدم النشاط والتكامل المالكين للعملية.

صيغة إنشاء التكامل

ترسل الواجهة الصيغة التالية بقيم مأخوذة من بيانات الخادم:

{
  "type": "<supported integration type>",
  "authMethod": "<supported authentication method>",
  "isActive": true
}

قائمة إصدار API خارجية

أكد المسارات والترويسات والنطاقات والمخططات والترقيم والأخطاء والحدود وفق عقد الخادم. للاستيراد أكد المعرّفات وحقول المتغيرات وسلوك التحديث والنتائج الجزئية والإعادة. للتوقيع أكد البايتات الأصلية والوقت والخوارزمية ومنع الإعادة.

لا يثبت هذا المستودع وحده وصفة HMAC خارجية أو جدول حدود عاماً أو مواعيد إعادة مضمونة أو عقد WebSocket عاماً. لا تنسخ بيانات جلسة اللوحة إلى خدمات خارجية. استُبدلت الأمثلة العامة السابقة لتجنب عرض عقود غير مثبتة كواجهات إنتاجية.

تشخيص الأخطاء

افحص حالة HTTP ونص الخطأ الفعلي، ثم التفويض والانتهاء وصلاحيات النشاط والتحقق والحدود التي يعرضها الخادم. سجّل معرّفات التتبع عند توفرها واحذف الأسرار. للأخطاء الفورية قارن الصندوق بعد التحديث ولا تبنِ مستهلكاً خارجياً اعتماداً على أسماء أحداث داخلية.

الخطوات التالية

راجع المصادقة وWebhooks والمنتجات الخارجية لمسارات الإعداد المدعومة.