Saltar al contenido principal

Descripción del esquema JSON

Este documento describe la estructura del esquema JSON del módulo Integrations.

Estructura general​

El esquema JSON es un array de objetos en el que cada objeto es un nodo o una pestaña (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"
      ]
    ]
  }
]

Parámetros principales de los nodos​

La mayoría de los nodos comparten estos parámetros:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (por ejemplo, "inject", "function", "template")
  • name (string) - nombre visible del nodo
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de arrays con los identificadores de los nodos a los que está conectada la salida

Nodos del sistema​

Nodo "tab" (pestaña)​

Un nodo tab es un contenedor para un grupo de nodos y se muestra en la interfaz como una pestaña.

Parámetros:

  • label (string) - nombre visible de la pestaña
  • id (string) - identificador único de la pestaña
  • type (string) - tipo de nodo (tab)
  • disabled (boolean) - indica si la pestaña está deshabilitada

Nodo "debug" (depuración)​

Un nodo debug muestra mensajes en el panel de depuración.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (debug)
  • name (string) - nombre visible del nodo
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Conexiones entre nodos​

El parámetro wires define las conexiones entre nodos. Cada elemento del array corresponde a una salida del nodo y contiene un array con los identificadores de los nodos conectados a esa salida.

Ejemplo:

"wires": [
  [
    "bd07e1ff0aedba0b"
  ]
]

Descripción de los parámetros de los nodos​

Nodo "inject" (inyector)​

El nodo inject sirve para crear mensajes y enviarlos manualmente al flujo.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (inject)
  • name (string) - nombre visible del nodo
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Nodo "function" (función)​

Un nodo function permite ejecutar código JavaScript arbitrario.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (function)
  • name (string) - nombre del nodo
  • func (string) - código que se ejecuta
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Nodo "template" (plantilla)​

Un nodo template transforma mensajes mediante plantillas.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (template)
  • name (string) - nombre del nodo
  • syntax (string) - sintaxis de la plantilla (mustache o plain)
  • template (string) - plantilla del mensaje
  • output (string) - tipo de salida: str (texto plano), json o yaml
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Nodo "interval-node" (intervalo)​

Un nodo interval-node genera mensajes a intervalos de tiempo definidos.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (interval-node)
  • name (string) - nombre del nodo
  • interval (number) - intervalo entre mensajes, en minutos
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Nodo "switch" (conmutador)​

Un nodo switch enruta los mensajes por distintos caminos según las condiciones.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (switch)
  • name (string) - nombre del nodo
  • property (string) - propiedad del mensaje que se comprueba
  • rules (array) - array de reglas de enrutamiento
  • outputs (number) - número de puertos de salida
  • checkall (string) - comprobar todas las reglas (true o false)
  • repair (boolean) - corregir los mensajes no válidos
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Nodo "split" (divisor)​

Un nodo split divide los mensajes en varias partes.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (split)
  • name (string) - nombre del nodo
  • property (string) - propiedad del mensaje que se divide
  • propertyType (string) - tipo de propiedad (msg, flow, global)
  • splt (string) - separador para cadenas
  • spltType (string) - tipo de separador (str, bin)
  • arraySplt (number) - tamaño de las partes para arrays
  • arraySpltType (string) - tipo de división de arrays (len, index)
  • stream (boolean) - modo de procesamiento en streaming
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Nodo "http in" (entrada HTTP)​

Un nodo http in crea endpoints HTTP y recibe solicitudes HTTP entrantes.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (http in)
  • name (string) - nombre del nodo (opcional)
  • url (string) - ruta URL del endpoint
  • method (string) - método HTTP (get, post, put, delete, patch)
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones para procesar las solicitudes

Nodo "http request" (solicitud HTTP)​

Un nodo http request realiza solicitudes HTTP salientes.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (http request)
  • name (string) - nombre del nodo
  • url (string) - URL de la solicitud
  • method (string) - método HTTP (GET, POST, PUT, DELETE, etc.)
  • ret (string) - formato de la respuesta (obj, txt, bin)
  • headers (array) - array de encabezados de la solicitud
  • paytoqs (string) - dónde se coloca el payload (body, query)
  • useAuth (boolean) - usar autenticación
  • authType (string) - tipo de autenticación (basic, bearer)
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones para procesar la respuesta

Nodo "http response" (respuesta HTTP)​

Un nodo http response envía respuestas HTTP al cliente.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (http response)
  • name (string) - nombre del nodo
  • statusCode (number) - código de estado HTTP de la respuesta
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones (normalmente vacío)

Nodo "cms-events"​

Este nodo permite rastrear eventos del módulo Events e inyectarlos en el flujo.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (cms-events)
  • name (string) - nombre del nodo
  • eventMarker (string) - identificador del evento
  • property (string) - propiedad del mensaje que se procesa
  • targetType (string) - tipo de destino del procesamiento (msg, flow, global)
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones para el procesamiento posterior

Nodo "admin-api" (Admin API)​

Este nodo permite interactuar con distintas API.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (admin-api)
  • name (string) - nombre del nodo
  • path (string) - ruta del endpoint de la API
  • method (string) - método HTTP (post, get, put, delete)
  • operation (string) - identificador de la operación
  • data (string) - datos de la solicitud en formato JSON
  • wires (array) - array de conexiones para procesar la respuesta

Nodo "telegram"​

Un nodo telegram envía mensajes a través de Telegram Bot API. Los campos se describen en detalle en la página del nodo telegram.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (telegram)
  • name (string) - nombre del nodo
  • botToken (string) - token del bot
  • chatId (string) - identificador del chat
  • text (string) - texto del mensaje
  • parseMode (string) - formato del texto (none, Markdown, MarkdownV2 o HTML)
  • replyMarkup (array) - filas de botones Inline; cada botón tiene text y callbackData
  • callbackQueryId (string) - identificador de la consulta de callback
  • showAlert (boolean) - mostrar la notificación en una ventana modal
  • notificationText (string) - texto de la notificación (con showAlert: true)
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Nodo "whatsapp"​

Un nodo whatsapp envía mensajes a través de WhatsApp Business Cloud API. Los campos se describen en detalle en la página del nodo whatsapp.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (whatsapp)
  • name (string) - nombre del nodo
  • phoneNumberId (string) - identificador del número remitente
  • accessToken (string) - token de acceso
  • apiVersion (string) - versión de Graph API (por defecto, v20.0)
  • action (string) - tipo de mensaje (message o template)
  • to (string) - número del destinatario
  • text (string) - texto del mensaje (con action: message)
  • templateName (string) - nombre de la plantilla (con action: template)
  • locale (string) - idioma de la plantilla (con action: template)
  • components (array) - parámetros de la plantilla; cada uno tiene type (header o body), parameter_name y text
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas

Nodo "notification"​

Un nodo notification envía una notificación basada en una plantilla de evento del módulo Events. Los campos se describen en detalle en la página del nodo notification.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (notification)
  • name (string) - nombre del nodo
  • eventId (number | null) - identificador de la plantilla de evento
  • variables (object) - valores de las variables de la plantilla, indexados por sus marcadores
  • recipientsPath (string) - ruta al array de destinatarios dentro del mensaje
  • x, y (number) - coordenadas del nodo en el área de trabajo
  • z (string) - identificador de la pestaña a la que pertenece el nodo
  • wires (array) - array de conexiones de las salidas
Última actualización en