Pular para o conteúdo principal

Descrição do esquema JSON

Neste documento, a estrutura do esquema JSON do módulo de Integrações é descrita.

Estrutura geral​

O esquema JSON é um array de objetos, onde cada objeto é um nó (node) ou uma aba (tab):

[
  {
    "label": "Olá 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": "debug",
    "x": 610.05078125,
    "y": 98.59765625,
    "z": "1f24387b252057fe",
    "wires": []
  },
  {
    "name": "function",
    "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": "template",
    "x": 418.66796875,
    "y": 98.19140625,
    "z": "1f24387b252057fe",
    "syntax": "mustache",
    "template": "Olá {{payload}} !",
    "output": "str",
    "wires": [
      [
        "2b524ca59e4ed633"
      ]
    ]
  }
]

Principais parâmetros dos nós​

A maioria dos nós possui os seguintes parâmetros comuns:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (por exemplo, "inject", "function", "template")
  • name (string) - nome exibido do nó
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de arrays de identificadores de nós aos quais a saída está conectada

Nós do sistema​

Nó "tab" (aba)​

O nó do tipo tab é um contêiner para um grupo de nós, visualmente exibido como uma aba na interface.

Parâmetros:

  • label (string) - nome exibido da aba
  • id (string) - identificador único da aba
  • type (string) - tipo do nó (tab)
  • disabled (boolean) - se a aba está desativada

Nó "debug" (depuração)​

O nó do tipo debug é usado para exibir mensagens no painel de depuração.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (debug)
  • name (string) - nome exibido do nó
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Conexões entre nós​

O parâmetro wires define as conexões entre os nós. Cada elemento do array corresponde à saída de um nó e contém um array de identificadores de nós aos quais essa saída está conectada.

Exemplo:

"wires": [
  [
    "bd07e1ff0aedba0b"
  ]
]

Descrição dos parâmetros dos nós​

Nó "inject" (injetor)​

O nó inject é usado para criar e enviar mensagens para o fluxo manualmente.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (inject)
  • name (string) - nome exibido do nó
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Nó "function" (função)​

O nó do tipo function permite executar código JavaScript arbitrário.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (function)
  • name (string) - nome do nó
  • func (string) - código executado
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Nó "template" (modelo)​

O nó do tipo template é usado para transformar mensagens usando modelos.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (template)
  • name (string) - nome do nó
  • syntax (string) - sintaxe do modelo (mustache ou plain)
  • template (string) - modelo da mensagem
  • output (string) - tipo de saída (str — texto simples, json ou yaml)
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Nó "interval-node" (intervalo)​

O nó do tipo interval-node é usado para gerar mensagens em intervalos de tempo definidos.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (interval-node)
  • name (string) - nome do nó
  • interval (number) - intervalo em minutos entre mensagens
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Nó "switch" (interruptor)​

O nó do tipo switch é usado para roteamento de mensagens por diferentes caminhos, dependendo das condições.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (switch)
  • name (string) - nome do nó
  • property (string) - propriedade da mensagem a ser verificada
  • rules (array) - array de regras para roteamento
  • outputs (number) - número de portas de saída
  • checkall (string) - verificar todas as regras (true ou false)
  • repair (boolean) - corrigir mensagens inválidas
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Nó "split" (divisor)​

O nó do tipo split é usado para dividir mensagens em várias partes.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (split)
  • name (string) - nome do nó
  • property (string) - propriedade da mensagem a ser dividida
  • propertyType (string) - tipo da propriedade (msg, flow, global)
  • splt (string) - delimitador para strings
  • spltType (string) - tipo de delimitador (str, bin)
  • arraySplt (number) - tamanho das partes para arrays
  • arraySpltType (string) - tipo de divisão de arrays (len, index)
  • stream (boolean) - modo de processamento em fluxo
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Nó "http in" (HTTP entrada)​

O nó do tipo http in é usado para criar endpoints HTTP e receber requisições HTTP de entrada.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (http in)
  • name (string) - nome do nó (opcional)
  • url (string) - caminho URL do endpoint
  • method (string) - método HTTP (get, post, put, delete, patch)
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para processamento de requisições

Nó "http request" (requisição HTTP)​

O nó do tipo http request é usado para executar requisições HTTP de saída.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (http request)
  • name (string) - nome do nó
  • url (string) - endereço URL para a requisição
  • method (string) - método HTTP (GET, POST, PUT, DELETE, etc.)
  • ret (string) - formato da resposta (obj, txt, bin)
  • headers (array) - array de cabeçalhos da requisição
  • paytoqs (string) - onde colocar o payload (body, query)
  • useAuth (boolean) - usar autenticação
  • authType (string) - tipo de autenticação (basic, bearer)
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para processamento da resposta

Nó "http response" (resposta HTTP)​

O nó do tipo http response é usado para enviar respostas HTTP ao cliente.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (http response)
  • name (string) - nome do nó
  • statusCode (number) - código de status HTTP da resposta
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões (geralmente vazia)

Nó "cms-events"​

Este nó permite rastrear eventos do módulo Events e injetá-los no fluxo.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (cms-events)
  • name (string) - nome do nó
  • eventMarker (string) - identificador do evento
  • property (string) - propriedade da mensagem para processamento
  • targetType (string) - tipo de alvo do processamento (msg, flow, global)
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para processamento adicional

Nó "admin-api" (Admin API)​

Este nó permite interagir com várias APIs.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (admin-api)
  • name (string) - nome do nó
  • path (string) - caminho do endpoint da API
  • method (string) - método HTTP (post, get, put, delete)
  • operation (string) - identificador da operação
  • data (string) - dados da requisição em formato JSON
  • wires (array) - array de conexões para processamento da resposta

Nó "telegram"​

O nó do tipo telegram envia mensagens através da API do Telegram Bot. Os campos são detalhados na página do nó telegram.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (telegram)
  • name (string) - nome do nó
  • botToken (string) - token do bot
  • chatId (string) - identificador do chat
  • text (string) - texto da mensagem
  • parseMode (string) - formato do texto (none, Markdown, MarkdownV2 ou HTML)
  • replyMarkup (array) - linhas de botões inline, cada botão com text e callbackData
  • callbackQueryId (string) - identificador da consulta de callback
  • showAlert (boolean) - mostrar notificação em uma janela modal
  • notificationText (string) - texto da notificação (quando showAlert: true)
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Nó "whatsapp"​

O nó do tipo whatsapp envia mensagens através da API do WhatsApp Business Cloud. Os campos são detalhados na página do nó whatsapp.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (whatsapp)
  • name (string) - nome do nó
  • phoneNumberId (string) - identificador do número do remetente
  • accessToken (string) - token de acesso
  • apiVersion (string) - versão da Graph API (padrão v20.0)
  • action (string) - tipo de mensagem (message ou template)
  • to (string) - número do destinatário
  • text (string) - texto da mensagem (quando action: message)
  • templateName (string) - nome do modelo (quando action: template)
  • locale (string) - idioma do modelo (quando action: template)
  • components (array) - parâmetros do modelo, cada um com type (header ou body), parameter_name e text
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas

Nó "notification"​

O nó do tipo notification envia uma notificação com base em um modelo de evento do módulo Events. Os campos são detalhados na página do nó notification.

Principais parâmetros:

  • id (string) - identificador único do nó
  • type (string) - tipo do nó (notification)
  • name (string) - nome do nó
  • eventId (number | null) - identificador do modelo de evento
  • variables (object) - valores das variáveis do modelo de acordo com seus marcadores
  • recipientsPath (string) - caminho para o array de destinatários na mensagem
  • x, y (number) - coordenadas do nó na área de trabalho
  • z (string) - identificador da aba à qual o nó pertence
  • wires (array) - array de conexões para saídas