انتقل إلى المحتوى

مرجع API

مرجع لعمليات WorkItem، وضوابط خطوة القرار، وتنفيذ التكامل، وتصدير القياس عن بعد.

تم تصميم واجهات برمجة التطبيقات هذه لسلوك التشغيل الآلي الذي يمكن التنبؤ به مع سياسة واضحة ونطاق المستأجر.

نقطة النهاية الأساسية

استخدم نقطة النهاية API العامة التي تم تكوينها للطلبات التي تمت مصادقتها.

https://api.threada.ai

المصادقة والسياق

  • استخدم بيانات الاعتماد المحددة للوصول إلى واجهة برمجة التطبيقات
  • قم بتضمين سياق المستأجر والدور عند الاقتضاء
  • فشل إغلاق الطلبات التي لا تحتوي على سياق صالح

نطاقات نموذجية

  • workitems:read و workitems:write
  • workflow:manage لتحديثات السياسة والقرارات
  • actions:execute للتنفيذ المحكوم
  • telemetry:read للتصدير والتحليل

ترقيم الصفحات والتصفية

  • تدعم نقاط نهاية القائمة ترقيم الصفحات القائم على المؤشر أو الرمز المميز
  • قم بالتصفية حسب القناة وسير العمل والحالة وإصدار السياسة والنطاق الزمني
  • تفضل النوافذ المحددة لصادرات القياس عن بعد الكبيرة

نموذج خطأ

  • فئات الأخطاء المكتوبة للتحقق من الصحة والترخيص والسياسة وفشل التنفيذ
  • تدعم أكواد الأسباب المعالجة الحتمية في أدوات المشغل
  • يتم إرجاع معرفات الارتباط للتحقيق عبر الخدمات

طلبات المثال

قم بإنشاء WorkItem من حمولة السحب

قم بإنشاء سجل عمل أساسي لمعالجة سير العمل. قم بتضمين معرف القناة لقناة السحب عند الحاجة.

طلب 
curl -X POST "https://api.threada.ai/work-items" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{\"workflow_id\":\"policy_review\",\"channel_id\":\"web_main\",\"payload\":{\"message\":\"Review this renewal request before approval\"}}"
إجابة 
{
  "work_item_id": "wi_123",
  "status": "new",
  "workflow_id": "policy_review"
}

تنفيذ الإجراء المعتمد

قم بتشغيل إجراء تمت الموافقة عليه من قبل السياسة مقابل التكامل الذي تم تكوينه.

طلب 
curl -X POST "https://api.threada.ai/actions/execute" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{\"work_item_id\":\"wi_123\",\"action_id\":\"request_approval\",\"integration_id\":\"int_workflow\"}"
إجابة 
{
  "execution_id": "ex_456",
  "status": "started",
  "idempotency_key": "idem_789"
}

هل تحتاج إلى إرشادات التنفيذ؟

استخدم المستندات والنظرة العامة الفنية لأنماط الطرح والحوكمة.

الاتصال بالفريق الفني