Saltar al contenido principal

Descripción del esquema JSON

En este documento se describe la estructura del esquema JSON del módulo de Integraciones.

Estructura general​

El esquema JSON consiste en un array de objetos, donde cada objeto es un nodo o una pestaña (tab):

[
  {
    "label": "¡Hola Mundo!",
    "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": "depuración",
    "x": 610.05078125,
    "y": 98.59765625,
    "z": "1f24387b252057fe",
    "wires": []
  },
  {
    "name": "función",
    "func": "msg.payload = 'Mundo'\n\nreturn msg;",
    "id": "bd07e1ff0aedba0b",
    "type": "function",
    "x": 229.62890625,
    "y": 98.8515625,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "2e1172b330c69aeb"
      ]
    ]
  },
  {
    "id": "2e1172b330c69aeb",
    "type": "template",
    "name": "plantilla",
    "x": 418.66796875,
    "y": 98.19140625,
    "z": "1f24387b252057fe",
    "syntax": "mustache",
    "template": "¡Hola {{payload}}!",
    "output": "str",
    "wires": [
      [
        "2b524ca59e4ed633"
      ]
    ]
  }
]

Parámetros principales de los nodos​

La mayoría de los nodos tienen los siguientes parámetros comunes:

  • 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 de identificadores de nodos a los que está conectado la salida

Nodos del sistema​

Nodo "tab" (pestaña)​

El nodo de tipo tab es un contenedor para un grupo de nodos, visualmente representado como una pestaña en la interfaz.

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) - si la pestaña está deshabilitada

Nodo "debug" (depuración)​

El nodo de tipo debug se utiliza para mostrar 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 para las salidas

Conexiones entre nodos​

El parámetro wires define las conexiones entre nodos. Cada elemento del array corresponde a la salida de un nodo y contiene un array de identificadores de nodos a los que está conectada esta salida.

Ejemplo:

"wires": [
  [
    "bd07e1ff0aedba0b"
  ]
]

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

Nodo "inject" (inyector)​

El nodo inject se utiliza para crear y enviar mensajes al flujo manualmente.

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 para las salidas

Nodo "function" (función)​

El nodo de tipo 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 a ejecutar
  • 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 las salidas

Nodo "template" (plantilla)​

El nodo de tipo template se utiliza para transformar mensajes utilizando 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 (plain, 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 para las salidas

Nodo "interval-node" (intervalo)​

El nodo de tipo interval-node se utiliza para generar mensajes a intervalos de tiempo especificados.

Parámetros principales:

  • id (string) - identificador único del nodo
  • type (string) - tipo de nodo (interval-node)
  • name (string) - nombre del nodo
  • interval (number) - intervalo en minutos entre mensajes
  • 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 las salidas

Nodo "switch" (interruptor)​

El nodo de tipo switch se utiliza para enrutar mensajes por diferentes 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 a verificar
  • rules (array) - array de reglas para el enrutamiento
  • outputs (number) - número de puertos de salida
  • checkall (string) - verificar todas las reglas (true o false)
  • repair (boolean) - corregir 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 para las salidas

Nodo "split" (divisor)​

El nodo de tipo split se utiliza para dividir 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 a dividir
  • propertyType (string) - tipo de propiedad (msg, flow, global)
  • splt (string) - delimitador para cadenas
  • spltType (string) - tipo de delimitador (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 flujo
  • 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 las salidas

Nodo "http in" (HTTP entrada)​

El nodo de tipo http in se utiliza para crear endpoints HTTP y recibir 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 solicitudes

Nodo "http request" (HTTP solicitud)​

El nodo de tipo http request se utiliza para realizar 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) - dirección URL para la solicitud
  • method (string) - método HTTP (GET, POST, PUT, DELETE, etc.)
  • ret (string) - formato de respuesta (obj, txt, bin)
  • headers (array) - array de encabezados de la solicitud
  • paytoqs (string) - dónde colocar 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" (HTTP respuesta)​

El nodo de tipo http response se utiliza para enviar 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 (generalmente vacío)

Nodo "cms-events"​

Este nodo permite rastrear eventos del módulo Events y enviarlos al 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 para procesar
  • targetType (string) - tipo de objetivo de 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 procesamiento adicional

Nodo "admin-api" (Admin API)​

Este nodo permite interactuar con diversas 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 del controlador
  • data (string) - datos de la solicitud en formato JSON
  • wires (array) - array de conexiones para procesar la respuesta