Skip to main content
Docsمنصة مفتوحةنقطة النهاية

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

Request/response and cURL examples for the 14 v1 endpoints, plus an end-to-end call flow.

The v1 open platform has 14 endpoints (3 for workflows, 4 for executions, 5 for approvals, 2 for artifacts), all mounted under the /api/v1/* prefix. وتدرج كل نقطة نهاية نطاقها المطلوب، وشكل الطلب، وشكل الاستجابة، ونموذجاً نموذجياً.

الاتفاقية العامة
  • الرخصة بالاستخدام: Bearer dyk id) secret); the X-API-Key header is also accepted (see the Authentication and rate limits) page)
  • All responses are application/json
  • الرد على الخطأ موحّد بـ "الطيور" بالنسبة لرموز مركز (هاتف) من فضلك انظر صفحة "التوثيق والحديد".
  • "العدام الذي بدأ بـ "ف1 لا يشارك في العطر الآلي والمتصل هو المسؤول عن إعادة التجريب/الإيجاب

درجة تدفق العمل

GET /api/v1/workflows

Scope: WORKFLOW_READ

تُدرج سير العمل المرئية إلى مالك (توكن) الحالي مجموعة الدعم: الصفحات 1: 50 (النقصان 50، الحد الأقصى 200).

bash
curl https://braidrun.com/api/v1/workflows?page=1&size=20 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

الرد:

json
{
  "items": [
    {
      "id": "wf-001",
      "name": "Daily ASA report",
      "ownerId": "u-alice",
      "workflow": [...]
    }
  ],
  "total": 17,
  "page": 1,
  "size": 20
}

GET /api/v1/workflows/{id}

Scope: WORKFLOW_READ

اقرأ تعريفاً واحداً لتدفق العمل (مع فحص النصيب/الإذن).

bash
curl https://braidrun.com/api/v1/workflows/wf-001 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

POST /api/v1/workflows/{id}/executions

Scope: WORKFLOW_EXECUTE

ابدأ تنفيذ جديد وتقدم هيئة الطلب الدعم للمدخلات ولتمكين مجالات الرصد. Response 202 accepteded (execution will occur asynchronously).

bash
curl -X POST https://braidrun.com/api/v1/workflows/wf-001/executions \
  -H "Authorization: Bearer dyk_<id>_<secret>" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": {
      "customer_id": "12345",
      "report_date": "2026-04-30"
    },
    "enableMonitoring": true
  }'

الرد (202 مقبولة):

json
{
  "executionId": "exec_a3b9c8...",
  "status": "PENDING",
  "workflowId": "wf-001",
  "startedAt": 1735632891234
}

بعد تلقي تنفيذ، استخدم GET /api/v1/executions/{id} حالة بولينج.

درجة التنفيذ

GET /api/v1/executions

Scope: EXECUTION_READ

قائمة مبدئية بتنفيذ للمالك الحالي هل يمكن أن تُلطخ من قبل؟.

bash
curl 'https://braidrun.com/api/v1/executions?status=RUNNING&size=10' \
  -H "Authorization: Bearer dyk_<id>_<secret>"

GET /api/v1/executions/{id}

Scope: EXECUTION_READ

يُعيد حالة التنفيذ في الوقت الحقيقي: الحالة/الوضع الراهن/الكامل/المجموعات/المجموعات/المجموعات/التكملة/الدرجة/الراتب.

bash
curl https://braidrun.com/api/v1/executions/exec_a3b9c8 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

المعنى الميداني للرد:

الميدانالنوعالوصف
statusstringPENDING / RUNNING / COMPLETED / FAILED / CANCELLED / INTERRUPTED
currentStepstring?The name of the step currently being executed (null if completed)
completedSteps / totalStepsintحانة التقدم
errorstring?رسالة خاطئة في ولاية القوات المسلحة
stepResultsmapاسم الخطوة → StepResult, including status / output / duration of each step

GET /api/v1/executions/{id}/result

Scope: EXECUTION_READ

Result, including stepResults + duration + overall output. ولا تتوفر القيمة إلا بعد انتهاء الخدمة (COMPLETED/FAILED/CANCELLED).

bash
curl https://braidrun.com/api/v1/executions/exec_a3b9c8/result \
  -H "Authorization: Bearer dyk_<id>_<secret>"

POST /api/v1/executions/{id}/cancel

Scope: EXECUTION_CANCEL

ألغي تنفيذ يعاد 404 إذا أنجز التنفيذ أو لم يكن موجودا.

bash
curl -X POST https://braidrun.com/api/v1/executions/exec_a3b9c8/cancel \
  -H "Authorization: Bearer dyk_<id>_<secret>"

الموافقة

عندما يصل تنفيذ إلى دليل - خطوة موافقة، يَتوقّفُ ويَجْعلُ سجل موافقة. وتقتضي النقاط الخمس الواردة أدناه النطاق المرجعي لبرنامج " APPROVAL RESPOND " : يمكن لنظام خارجي أن يدرج في قائمة الموافقات، ويقرأ تفاصيل الموافقة (بما في ذلك بيانات الموافقة على الجدول الإلكتروني)، ويوافق على ذلك أو يرفضه. عند الموافقة، التنفيذ مستمرّ، عند الرفض، يتوقّف، تجاوز الوقت المُحدّد للمُوافقة.

GET /api/v1/approvals

Scope: APPROVAL_RESPOND

أُدرج سجلات الموافقة المرئية للمالك الشهير الحالي. Filter by ?status= (e.g. PENDING); paginate with ?page=1size=20 (default 20, max200).

bash
curl 'https://braidrun.com/api/v1/approvals?status=PENDING&page=1&size=20' \
  -H "Authorization: Bearer dyk_<id>_<secret>"

الرد:

json
{
  "approvals": [
    {
      "id": "apr-001",
      "executionId": "exec_a3b9c8...",
      "workflowId": "wf-001",
      "stepName": "review_bid_changes",
      "status": "PENDING",
      "approvalMessage": "42 条出价调整待确认",
      "timeout": 86400,
      "createdAt": 1735632891234,
      "expiresAt": 1735719291234,
      "reviewableGroups": [
        {
          "name": "bid_changes",
          "title": "出价调整",
          "items": [],
          "itemsCount": 42
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "size": 20
}
نقطة نهاية القائمة لا ترد تفاصيل الموافقة

ولإبقاء الردود صغيرة، تعيد نقاط نهاية القائمة (بما في ذلك الاستفسارات الفرعية) صفيفة أصناف فارغة داخل مجموعات يمكن استعراضها، وتحتفظ فقط بالبنود التي تحسب من الصفوف. وللاطلاع على التفاصيل الكاملة، يرجى الاتصال بنقطة النهاية GET /api/v1/approvals/{id}.

GET /api/v1/approvals/{id}

Scope: APPROVAL_RESPOND

اقرأ موافقة واحدة كاملة: الحالة/الدرجة/الإجازة / / /.

bash
curl https://braidrun.com/api/v1/approvals/apr-001 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

GET /api/v1/approvals/execution/{executionId}

Scope: APPROVAL_RESPOND

انظر إلى الموافقة عن طريق التنفيذ: تعيد جميع سجلات الموافقة التي ينتجها هذا التنفيذ (تجرد البنود هنا أيضا). وعندما تكشف حالة الاقتراع عن وقف التنفيذ، تستخدمه لإيجاد الموافقة على العمل.

bash
curl https://braidrun.com/api/v1/approvals/execution/exec_a3b9c8 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

POST /api/v1/approvals/{id}/approve

Scope: APPROVAL_RESPOND

وافق ودع تنفيذ يستمر كل حقول الطلب اختيارية: التعليق هو مذكرة المستعرض؛ التحرير.

bash
curl -X POST https://braidrun.com/api/v1/approvals/apr-001/approve \
  -H "Authorization: Bearer dyk_<id>_<secret>" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "确认执行，两条出价手动下调",
    "editedItems": {
      "bid_changes": [
        {"keyword": "photo editor", "newBid": 0.65},
        {"keyword": "collage maker", "newBid": 0.55}
      ]
    }
  }'

والرد هو سجل الموافقة المستكمل (المركز = البرنامج الإنمائي). يعاد 404 إذا لم تكن الموافقة موجودة أو تمت معالجتها بالفعل.

POST /api/v1/approvals/{id}/reject

Scope: APPROVAL_RESPOND

رفض الموافقة، ثم يتوقف التنفيذ ولا يجري أي تغيير حي. ويسجل ميدان التعليق الاختياري في هيئة الطلب سبب الرفض.

bash
curl -X POST https://braidrun.com/api/v1/approvals/apr-001/reject \
  -H "Authorization: Bearer dyk_<id>_<secret>" \
  -H "Content-Type: application/json" \
  -d '{"comment": "本周预算已用完，先不调整"}'

فئة المنتجات

GET /api/v1/executions/{id}/artifacts

Scope: ARTIFACT_READ

إدراج جميع المنتجات التي يولدها هذا التنفيذ (بما في ذلك الملفات، والتقارير، والصور المغلقة، وما إلى ذلك، التي تولدت في كل خطوة).

bash
curl https://braidrun.com/api/v1/executions/exec_a3b9c8/artifacts \
  -H "Authorization: Bearer dyk_<id>_<secret>"

الرد:

json
{
  "artifacts": [
    {
      "id": "art-001",
      "name": "daily-report.xlsx",
      "path": "executions/exec_a3b9c8/.../daily-report.xlsx",
      "storageKey": "executions/exec_a3b9c8/.../daily-report.xlsx",
      "downloadUrl": "/api/executions/exec_a3b9c8/artifacts/art-001/download",
      "previewable": false
    }
  ],
  "total": 1
}

GET /api/v1/executions/{id}/artifacts/{aid}

Scope: ARTIFACT_READ

Meta information of a single product, including downloadUrl field. ويستخدم العميل التحميل (Url) لسحب محتوى الملف الفعلي مباشرة (ليس من خلال نقطة النهاية " v1 " ، باستخدام الحصة مجانا).

bash
curl https://braidrun.com/api/v1/executions/exec_a3b9c8/artifacts/art-001 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

التدفق الكامل للسيارات:

bash
# 1. 启动执行
EXEC_ID=$(curl -s -X POST \
  https://braidrun.com/api/v1/workflows/wf-001/executions \
  -H "Authorization: Bearer $DYK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {"customer_id": "12345"}}' \
  | jq -r .executionId)

# 2. 轮询直到完成
while true; do
  STATUS=$(curl -s \
    "https://braidrun.com/api/v1/executions/$EXEC_ID" \
    -H "Authorization: Bearer $DYK_TOKEN" \
    | jq -r .status)
  echo "$EXEC_ID: $STATUS"
  case $STATUS in
    COMPLETED|FAILED|CANCELLED) break ;;
  esac
  sleep 5
done

# 3. 拿产物列表
curl -s "https://braidrun.com/api/v1/executions/$EXEC_ID/artifacts" \
  -H "Authorization: Bearer $DYK_TOKEN" | jq .artifacts

الخطط المقبلة

  • ملف المطياف المفتوح - لشركة Swagger UI/ Auto-generated SDK
  • الرسمي (بيتون/نوديس)
  • أحداث موافقة الموظفين: GET /api/v1/executions/{id}/events realtime push progress
  • استرجاع الحدث على شبكة الويب (استعد عند الانتهاء من التنفيذ)