Aller au contenu principal

Description du schéma JSON

Ce document décrit la structure du schéma JSON du module Intégrations.

Structure générale​

Le schéma JSON est un tableau d'objets, où chaque objet est soit un nœud, soit un onglet :

[
  {
    "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"
      ]
    ]
  }
]

Paramètres principaux des nœuds​

La plupart des nœuds ont les paramètres communs suivants :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (par exemple, "inject", "function", "template")
  • name (string) - nom affiché du nœud
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de tableaux d'identifiants de nœuds auxquels la sortie est connectée

Nœuds système​

Nœud "tab" (onglet)​

Le nœud de type tab représente un conteneur pour un groupe de nœuds, affiché visuellement comme un onglet dans l'interface.

Paramètres :

  • label (string) - nom affiché de l'onglet
  • id (string) - identifiant unique de l'onglet
  • type (string) - type de nœud (tab)
  • disabled (boolean) - l'onglet est-il désactivé

Nœud "debug" (débogage)​

Le nœud de type debug est utilisé pour afficher des messages dans le panneau de débogage.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (debug)
  • name (string) - nom affiché du nœud
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour les sorties

Liens entre les nœuds​

Le paramètre wires définit les connexions entre les nœuds. Chaque élément du tableau correspond à une sortie d'un nœud et contient un tableau d'identifiants de nœuds auxquels cette sortie est connectée.

Exemple :

"wires": [
  [
    "bd07e1ff0aedba0b"
  ]
]

Description des paramètres des nœuds​

Nœud "inject" (injecteur)​

Le nœud inject est utilisé pour créer et envoyer des messages dans le flux manuellement.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (inject)
  • name (string) - nom affiché du nœud
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour les sorties

Nœud "function" (fonction)​

Le nœud de type function permet d'exécuter du code JavaScript arbitraire.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (function)
  • name (string) - nom du nœud
  • func (string) - code exécuté
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour les sorties

Nœud "template" (modèle)​

Le nœud de type template est utilisé pour transformer des messages en utilisant des modèles.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (template)
  • name (string) - nom du nœud
  • syntax (string) - syntaxe du modèle (mustache ou plain)
  • template (string) - modèle de message
  • output (string) - type de sortie (plain, json ou yaml)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour les sorties

Nœud "interval-node" (intervalle)​

Le nœud de type interval-node est utilisé pour générer des messages à intervalles réguliers.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (interval-node)
  • name (string) - nom du nœud
  • interval (number) - intervalle en minutes entre les messages
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour les sorties

Nœud "switch" (interrupteur)​

Le nœud de type switch est utilisé pour router des messages sur différents chemins en fonction des conditions.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (switch)
  • name (string) - nom du nœud
  • property (string) - propriété du message à vérifier
  • rules (array) - tableau de règles pour le routage
  • outputs (number) - nombre de ports de sortie
  • checkall (string) - vérifier toutes les règles (true ou false)
  • repair (boolean) - corriger les messages invalides
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour les sorties

Nœud "split" (séparateur)​

Le nœud de type split est utilisé pour diviser des messages en plusieurs parties.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (split)
  • name (string) - nom du nœud
  • property (string) - propriété du message à diviser
  • propertyType (string) - type de propriété (msg, flow, global)
  • splt (string) - séparateur pour les chaînes
  • spltType (string) - type de séparateur (str, bin)
  • arraySplt (number) - taille des parties pour les tableaux
  • arraySpltType (string) - type de séparation des tableaux (len, index)
  • stream (boolean) - mode de traitement en continu
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour les sorties

Nœud "http in" (HTTP entrée)​

Le nœud de type http in est utilisé pour créer des points de terminaison HTTP et recevoir des requêtes HTTP entrantes.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (http in)
  • name (string) - nom du nœud (facultatif)
  • url (string) - chemin URL du point de terminaison
  • method (string) - méthode HTTP (get, post, put, delete, patch)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour le traitement des requêtes

Nœud "http request" (requête HTTP)​

Le nœud de type http request est utilisé pour effectuer des requêtes HTTP sortantes.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (http request)
  • name (string) - nom du nœud
  • url (string) - adresse URL pour la requête
  • method (string) - méthode HTTP (GET, POST, PUT, DELETE, etc.)
  • ret (string) - format de la réponse (obj, txt, bin)
  • headers (array) - tableau d'en-têtes de la requête
  • paytoqs (string) - où placer le payload (body, query)
  • useAuth (boolean) - utiliser l'authentification
  • authType (string) - type d'authentification (basic, bearer)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour le traitement de la réponse

Nœud "http response" (réponse HTTP)​

Le nœud de type http response est utilisé pour envoyer des réponses HTTP au client.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (http response)
  • name (string) - nom du nœud
  • statusCode (number) - code de statut HTTP de la réponse
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions (généralement vide)

Nœud "cms-events"​

Ce nœud permet de suivre les événements du module Events et de les injecter dans le flux.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (cms-events)
  • name (string) - nom du nœud
  • eventMarker (string) - identifiant de l'événement
  • property (string) - propriété du message à traiter
  • targetType (string) - type de cible de traitement (msg, flow, global)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel appartient le nœud
  • wires (array) - tableau de connexions pour un traitement ultérieur

Nœud "admin-api" (Admin API)​

Ce nœud permet d'interagir avec diverses API.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type de nœud (admin-api)
  • name (string) - nom du nœud
  • path (string) - chemin de l'API du point de terminaison
  • method (string) - méthode HTTP (post, get, put, delete)
  • operation (string) - identifiant de l'opération du contrôleur
  • data (string) - données de la requête au format JSON
  • wires (array) - tableau de connexions pour le traitement de la réponse