وصف مخطط JSON

يصف هذا المستند بنية مخطط JSON في وحدة Integrations.

الهيكل العام

مخطط JSON مصفوفة من الكائنات، وكل كائن فيها إما عقدة (node) أو علامة تبويب (tab):

[
  {
    "label": "Hello World!",
    "id": "1f24387b252057fe",
    "type": "tab",
    "disabled": false
  },
  {
    "name": "run",
    "id": "b51ab819b83e1915",
    "type": "inject",
    "x": 46.96875,
    "y": 99.51171875,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "bd07e1ff0aedba0b"
      ]
    ]
  },
  {
    "id": "2b524ca59e4ed633",
    "type": "debug",
    "name": "debug",
    "x": 610.05078125,
    "y": 98.59765625,
    "z": "1f24387b252057fe",
    "wires": []
  },
  {
    "name": "function",
    "func": "msg.payload = 'World'\n\nreturn msg;",
    "id": "bd07e1ff0aedba0b",
    "type": "function",
    "x": 229.62890625,
    "y": 98.8515625,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "2e1172b330c69aeb"
      ]
    ]
  },
  {
    "id": "2e1172b330c69aeb",
    "type": "template",
    "name": "template",
    "x": 418.66796875,
    "y": 98.19140625,
    "z": "1f24387b252057fe",
    "syntax": "mustache",
    "template": "Hello {{payload}} !",
    "output": "str",
    "wires": [
      [
        "2b524ca59e4ed633"
      ]
    ]
  }
]

المعلمات الأساسية للعقد

تشترك معظم العقد في المعلمات التالية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (مثل "inject" و"function" و"template")
• name (string) - الاسم المعروض للعقدة
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة من مصفوفات معرّفات العقد المتصلة بالمخرج

العقد النظامية

عقدة "tab" (علامة تبويب)

العقدة من نوع tab حاوية لمجموعة من العقد، وتظهر في الواجهة على شكل علامة تبويب.

المعلمات:

• label (string) - الاسم المعروض لعلامة التبويب
• id (string) - معرّف فريد لعلامة التبويب
• type (string) - نوع العقدة (tab)
• disabled (boolean) - ما إذا كانت علامة التبويب معطّلة

عقدة "debug" (تصحيح)

تعرض العقدة من نوع debug الرسائل في لوحة التصحيح.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (debug)
• name (string) - الاسم المعروض للعقدة
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

الروابط بين العقد

تحدد المعلمة wires الروابط بين العقد. يقابل كل عنصر في المصفوفة أحد مخرجات العقدة، ويحتوي على مصفوفة بمعرّفات العقد المتصلة بهذا المخرج.

مثال:

"wires": [
  [
    "bd07e1ff0aedba0b"
  ]
]

وصف معلمات العقد

عقدة "inject" (حقن)

تُستخدم العقدة inject لإنشاء الرسائل وإرسالها يدويًا إلى التدفق.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (inject)
• name (string) - الاسم المعروض للعقدة
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

عقدة "function" (دالة)

تتيح العقدة من نوع function تنفيذ أي كود JavaScript.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (function)
• name (string) - اسم العقدة
• func (string) - الكود الذي يُنفَّذ
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

عقدة "template" (قالب)

تحوّل العقدة من نوع template الرسائل باستخدام القوالب.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (template)
• name (string) - اسم العقدة
• syntax (string) - صيغة القالب (mustache أو plain)
• template (string) - قالب الرسالة
• output (string) - نوع المخرجات (str للنص العادي، أو json، أو yaml)
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

عقدة "interval-node" (فاصل زمني)

تولّد العقدة من نوع interval-node الرسائل على فترات زمنية محددة.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (interval-node)
• name (string) - اسم العقدة
• interval (number) - الفترة بين الرسائل بالدقائق
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

عقدة "switch" (مبدّل)

توجّه العقدة من نوع switch الرسائل إلى مسارات مختلفة حسب الشروط.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (switch)
• name (string) - اسم العقدة
• property (string) - خاصية الرسالة التي يجري فحصها
• rules (array) - مصفوفة قواعد التوجيه
• outputs (number) - عدد منافذ الإخراج
• checkall (string) - ما إذا كانت تُفحص جميع القواعد (true أو false)
• repair (boolean) - ما إذا كانت تُصلح الرسائل غير الصالحة
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

عقدة "split" (مقسِّم)

تقسّم العقدة من نوع split الرسائل إلى عدة أجزاء.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (split)
• name (string) - اسم العقدة
• property (string) - خاصية الرسالة المراد تقسيمها
• propertyType (string) - نوع الخاصية (msg، flow، global)
• splt (string) - فاصل السلاسل النصية
• spltType (string) - نوع الفاصل (str، bin)
• arraySplt (number) - حجم أجزاء المصفوفات
• arraySpltType (string) - طريقة تقسيم المصفوفات (len، index)
• stream (boolean) - وضع المعالجة المتدفقة
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

عقدة "http in" (مدخل HTTP)

تُنشئ العقدة من نوع http in نقاط نهاية HTTP وتستقبل طلبات HTTP الواردة.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (http in)
• name (string) - اسم العقدة (اختياري)
• url (string) - مسار URL لنقطة النهاية
• method (string) - طريقة HTTP (get، post، put، delete، patch)
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة الاتصالات التي تعالج الطلبات

عقدة "http request" (طلب HTTP)

ترسل العقدة من نوع http request طلبات HTTP صادرة.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (http request)
• name (string) - اسم العقدة
• url (string) - عنوان URL للطلب
• method (string) - طريقة HTTP (GET، POST، PUT، DELETE، إلخ)
• ret (string) - تنسيق الاستجابة (obj، txt، bin)
• headers (array) - مصفوفة رؤوس الطلب
• paytoqs (string) - موضع الحمولة (payload) في الطلب (body، query)
• useAuth (boolean) - ما إذا كانت تُستخدم المصادقة
• authType (string) - نوع المصادقة (basic، bearer)
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة الاتصالات التي تعالج الاستجابة

عقدة "http response" (استجابة HTTP)

ترسل العقدة من نوع http response استجابات HTTP إلى العميل.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (http response)
• name (string) - اسم العقدة
• statusCode (number) - رمز حالة HTTP للاستجابة
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة الاتصالات (فارغة عادةً)

عقدة "cms-events"

تتيح هذه العقدة تتبّع الأحداث من وحدة Events وإدخالها في التدفق.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (cms-events)
• name (string) - اسم العقدة
• eventMarker (string) - معرّف الحدث
• property (string) - خاصية الرسالة المراد معالجتها
• targetType (string) - نوع هدف المعالجة (msg، flow، global)
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة الاتصالات لمتابعة المعالجة

عقدة "admin-api" (Admin API)

تتيح هذه العقدة التفاعل مع واجهات API مختلفة.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (admin-api)
• name (string) - اسم العقدة
• path (string) - مسار نقطة نهاية API
• method (string) - طريقة HTTP (post، get، put، delete)
• operation (string) - معرّف العملية
• data (string) - بيانات الطلب بتنسيق JSON
• wires (array) - مصفوفة الاتصالات التي تعالج الاستجابة

عقدة "telegram"

ترسل العقدة من نوع telegram الرسائل عبر Telegram Bot API. الحقول موصوفة بالتفصيل في صفحة العقدة telegram.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (telegram)
• name (string) - اسم العقدة
• botToken (string) - رمز البوت (token)
• chatId (string) - معرّف الدردشة
• text (string) - نص الرسالة
• parseMode (string) - تنسيق النص (none أو Markdown أو MarkdownV2 أو HTML)
• replyMarkup (array) - صفوف أزرار Inline، ولكل زر text وcallbackData
• callbackQueryId (string) - معرّف طلب callback
• showAlert (boolean) - ما إذا كان الإشعار يُعرض في نافذة منبثقة
• notificationText (string) - نص الإشعار (عند showAlert: true)
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

عقدة "whatsapp"

ترسل العقدة من نوع whatsapp الرسائل عبر WhatsApp Business Cloud API. الحقول موصوفة بالتفصيل في صفحة العقدة whatsapp.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (whatsapp)
• name (string) - اسم العقدة
• phoneNumberId (string) - معرّف رقم المرسل
• accessToken (string) - رمز الوصول
• apiVersion (string) - إصدار Graph API (القيمة الافتراضية v20.0)
• action (string) - نوع الرسالة (message أو template)
• to (string) - رقم المستلم
• text (string) - نص الرسالة (عند action: message)
• templateName (string) - اسم القالب (عند action: template)
• locale (string) - لغة القالب (عند action: template)
• components (array) - معلمات القالب، ولكل منها type (header أو body) وparameter_name وtext
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات

عقدة "notification"

ترسل العقدة من نوع notification إشعارًا وفق قالب حدث من وحدة Events. الحقول موصوفة بالتفصيل في صفحة العقدة notification.

المعلمات الأساسية:

• id (string) - معرّف فريد للعقدة
• type (string) - نوع العقدة (notification)
• name (string) - اسم العقدة
• eventId (number | null) - معرّف قالب الحدث
• variables (object) - قيم متغيرات القالب حسب علاماتها (markers)
• recipientsPath (string) - مسار مصفوفة المستلمين داخل الرسالة
• x، y (number) - إحداثيات العقدة في مساحة العمل
• z (string) - معرّف علامة التبويب التي تنتمي إليها العقدة
• wires (array) - مصفوفة اتصالات المخرجات