مرجع API

    تشغيل تدفق

    ابدأ تشغيلاً واحداً لتدفق نشط ببيانات JSON.

    POST/api/trigger/{flowId}

    يرسل جسم الطلب إلى خطوة المشغّل في التدفق ويسجّل تشغيلاً واحداً. يردّ الطلب فوراً بالرمز 202 ومعرّف التنفيذ، ولا ينتظر انتهاء التدفق أبداً. يجب أن يكون التدفق نشطاً وأن ينتمي إلى مساحة عمل المفتاح.

    للأدوات ووكلاء الذكاء الاصطناعي: هذه الصفحة بصيغة Markdown · ملف OpenAPI العام

    التفويض

    أرسل مفتاح API يحمل صلاحية execute في الترويسة X-Api-Key. يُنشئ المسؤول أو المالك المفاتيح من صفحة مفاتيح API في التطبيق، ويشرح مرجع API الصلاحيات وانتهاء الصلاحية والاستبدال.

    تحتاج إلى مفتاح API يحمل صلاحية execute ويُرسل في الترويسة X-Api-Key.

    معاملات المسار

    الاسمالنوعمطلوبالوصف
    flowIdstringنعممعرّف التدفق. يجب أن يكون التدفق نشطاً وأن ينتمي إلى مساحة عمل المفتاح.

    الترويسات

    الاسممطلوبالوصف
    X-Api-Keyنعممفتاح API الخاص بك: exo_ تليها 64 خانة ست عشرية.
    Content-Typeلاأرسل application/json. من دونه لا يُقرأ الجسم: يُقبل الطلب مع ذلك ويبدأ التشغيل ببيانات مشغّل فارغة.
    X-Webhook-Signatureلامطلوب فقط عند ضبط سرّ توقيع لمساحة العمل: قيمة HMAC-SHA256 للجسم الخام بصيغة ست عشرية بأحرف صغيرة. الصيغ الأخرى المقبولة مذكورة في مرجع API.

    الجسم

    أي كائن JSON حتى 8 ميغابايت. يصبح بيانات المشغّل للتشغيل، ويُقرأ أي حقل في التدفق هكذا: {{trigger.order_id}}. لا يُفحص الجسم وفق مخطط.

    الاستجابات

    202

    مقبول. يوضح الحقل status ما حدث: queued (التشغيل ينتظر عاملاً)، أو held (تجاوزت مساحة العمل 120% من حصتها الشهرية، ويبدأ التشغيل تلقائياً بعد الشحن أو الترقية أو بداية الشهر)، أو duplicate_suppressed (وصل الجسم نفسه إلى التدفق نفسه خلال 10 ثوانٍ ولم يبدأ تشغيل ثانٍ؛ وexecutionId هو تشغيل التسليم الأول، أو null إذا لم يكن معروفاً).

    {
      "executionId": "0b6f6c1e-5a55-4d0e-9a57-2f7c1d0e8a11",
      "status": "queued"
    }
    الحالةالمعنىالرسالة
    400التدفق موجود لكنه غير نشط.Flow is not active
    401الترويسة X-Api-Key مفقودة، أو أن سرّ توقيع مضبوط والتوقيع مفقود أو غير مطابق.API key required. Include X-Api-Key header. · Webhook signature verification failed
    403المفتاح غير معروف أو غير نشط أو منتهي الصلاحية، أو لا يحمل execute، أو أن مساحة العمل موقوفة.Invalid or inactive API key · API key expired · API key lacks execute permission · Tenant not found or suspended
    404لا يوجد تدفق بهذا المعرّف في مساحة عمل المفتاح. تدفقات مساحات العمل الأخرى تردّ أيضاً بالرمز 404.Flow not found
    429طلبات كثيرة خلال دقيقة. انتظر عدد الثواني المذكور في الترويسة Retry-After.Too many requests, please try again later · Rate limit exceeded for webhook triggers · Rate limit exceeded: too many trigger calls for this workspace in the last minute. Retry shortly.
    413الجسم أكبر من 8 ميغابايت، أو يتداخل لأكثر من 64 مستوى، أو فيه أكثر من 500,000 مفتاح، أو أُرسل مضغوطاً ويتمدد إلى أضعاف حجمه المضغوط بكثير. الجسم الأكبر من الحجم يُرفض قبل البحث عن التدفق وفي ردّه حقل message وحده؛ والحالات الأخرى تردّ { error, code, message }.request entity too large · Payload nesting exceeds the depth limit of 64 · The compressed request body expands far beyond its compressed size. Send it uncompressed or split it.
    500تعذّر تسجيل التشغيل. أعد المحاولة، وإذا تكرر ذلك فتواصل مع الدعم.Trigger failed

    تظهر الرسائل كما يرسلها الخادم تماماً، بالإنجليزية. القيمة بين علامتي < > تُملأ وقت التشغيل.

    أمثلة

    curl -X POST https://exomations.com/api/trigger/YOUR_FLOW_ID \
      -H "X-Api-Key: exo_your_key" \
      -H "Content-Type: application/json" \
      -d '{"order_id":"1042","customer":{"phone":"+9665XXXXXXXX"}}'