رفتن به محتوا

مرجع API

مرجع عملیات WorkItem، کنترل‌های گام تصمیم، اجرای یکپارچه‌سازی و خروجی تله‌متری.

این APIها برای رفتار خودکارسازی قابل پیش‌بینی با محدوده‌بندی صریح سیاست و tenant طراحی شده‌اند.

endpoint پایه

برای درخواست‌های احراز هویت‌شده از endpoint عمومی API پیکربندی‌شده خود استفاده کنید.

https://api.threada.ai

احراز هویت و context

  • برای دسترسی API از اعتبارنامه‌های محدود استفاده کنید
  • در صورت نیاز context tenant و نقش را اضافه کنید
  • درخواست‌های بدون context معتبر به‌صورت fail closed شکست می‌خورند

محدوده‌های معمول

  • workitems:read و workitems:write
  • workflow:manage برای سیاست و به‌روزرسانی‌های تصمیم
  • actions:execute برای اجرای کنترل‌شده
  • telemetry:read برای خروجی‌ها و تحلیل

صفحه‌بندی و فیلتر

  • endpointهای فهرست از صفحه‌بندی مبتنی بر cursor یا token پشتیبانی می‌کنند
  • براساس کانال، گردش کار، وضعیت، نسخه سیاست و بازه زمانی فیلتر کنید
  • برای خروجی‌های بزرگ تله‌متری، windowهای محدود را ترجیح دهید

مدل خطا

  • دسته‌های خطای typed برای شکست‌های اعتبارسنجی، مجوز، سیاست و اجرا
  • کدهای دلیل از رسیدگی deterministic در ابزار اپراتور پشتیبانی می‌کنند
  • correlation IDها برای بررسی بین‌سرویسی برگردانده می‌شوند

درخواست‌های نمونه

ایجاد WorkItem از payload دریافت

یک رکورد کار canonical برای پردازش گردش کار ایجاد کنید. در صورت نیاز، شناسه کانال را برای کانال دریافت وارد کنید.

درخواست 
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"
}

به راهنمایی پیاده‌سازی نیاز دارید؟

برای الگوهای عرضه و حاکمیت از اسناد و نمای کلی فنی استفاده کنید.

تماس با تیم فنی