Aller au contenu principal

Introduction

Le module "Integrations" permet de relier des API et des services en ligne par programmation visuelle. Vous faites glisser des nœuds dans l'espace de travail et les connectez entre eux pour construire visuellement la logique de vos applications. Le développement devient ainsi accessible même à ceux qui ne sont pas programmeurs professionnels, et l'intégration de différents systèmes est nettement plus rapide :

Éléments principaux de l'interface du module Integrations​

1. Panneau gauche avec les nœuds​

Le panneau gauche contient tous les nœuds disponibles. Ce sont les éléments à partir desquels vous construisez vos flux de données.

Pour utiliser un nœud, faites-le glisser dans la zone de travail. Chaque nœud a sa propre fonction et ses propres réglages.

Exemples de nœuds :

  • Inject : envoie manuellement des données dans le flux.
  • Debug : affiche les données et les messages dans le menu de débogage.
  • Function : permet d'écrire du code JavaScript personnalisé.
  • Template : sert à créer des modèles texte ou HTML.

2. Onglets​

Les onglets, situés au-dessus de la zone de travail, permettent de passer d'un projet ou d'un flux de données à l'autre. Ils sont utiles si vous travaillez sur plusieurs intégrations à la fois ou si vous voulez répartir la logique sur plusieurs flux.

  • Créer un onglet : cliquez sur le bouton plus +. Chaque onglet est un flux de données distinct, ce qui aide à organiser le projet.
  • Renommer un onglet : double-cliquez sur son nom et saisissez le nouveau nom. C'est particulièrement utile si vous avez beaucoup d'onglets et voulez voir d'un coup d'œil ce que contient chacun d'eux.
  • Supprimer un onglet : faites un clic droit sur l'onglet et choisissez Delete dans le menu contextuel. Attention à ne pas perdre de données importantes.
  • Désactiver un onglet : dans le même menu contextuel, Disable désactive le flux de l'onglet sans le supprimer. Pour un onglet désactivé, l'option devient Enable et réactive le flux. Dans le schéma JSON, cet état est enregistré dans le champ disabled de l'onglet.

Exemple : si vous travaillez sur une intégration de paiements, vous pouvez créer un onglet distinct pour chaque service.

3. Zone de travail​

La zone de travail est la partie centrale de l'interface, où vous construisez et modifiez vos flux de données.

  • Placer des nœuds : le nœud que vous faites glisser depuis le panneau gauche apparaît dans la zone de travail. Vous pouvez alors le déplacer, le connecter à d'autres nœuds et construire la logique de votre flux.
  • Connecter des nœuds : tirez une ligne depuis la sortie d'un nœud jusqu'à l'entrée d'un autre. Les données circulent alors d'un nœud à l'autre le long du flux.
  • Gérer les flux : vous pouvez créer plusieurs flux de données dans la zone de travail, ce qui aide à organiser des intégrations et une logique complexes.

Conseil : zoomez dans la zone de travail avec la souris ou le pavé tactile pour voir tous les détails de votre flux.

4. Formulaire d'édition du nœud​

Double-cliquez sur un nœud dans la zone de travail pour ouvrir le formulaire d'édition du nœud, où vous configurez son comportement.

  • Champs de paramètres : chaque nœud a ses propres paramètres modifiables. Dans un nœud Function, par exemple, vous pouvez écrire et modifier du code.
  • Enregistrer les modifications : une fois le nœud modifié, cliquez sur Submit pour enregistrer.

Exemple : dans un nœud Function, vous pouvez écrire du code JavaScript qui transforme les données. Dans un nœud Template, vous pouvez créer un modèle qui insère les données dynamiquement.

5. Panneau de débogage​

Le panneau de débogage se trouve à droite. Il affiche les données de sortie et les messages des nœuds Debug. Il comporte deux onglets : Debug (messages du flux) et Configuration.

  • Consulter les messages : lorsque vous lancez un flux de données, les nœuds Debug envoient leurs messages dans l'onglet Debug. Vous voyez ainsi ce qui se passe dans le flux et pouvez vérifier que les données sont correctes.
  • Filtrer les messages : la liste au-dessus des messages détermine leur provenance : all nodes pour tous les nœuds, current workflow pour les seuls nœuds de l'onglet actuel. C'est utile lorsque plusieurs nœuds Debug produisent beaucoup de données de sortie.
  • Vider la fenêtre Debug : cliquez sur l'icône en forme de croix à côté du filtre pour supprimer les anciens messages et vous concentrer sur les nouvelles données.

Exemple : si un nœud Function effectue des calculs, ajoutez un nœud Debug en fin de flux pour vérifier que votre code traite correctement les données.

6. Boutons de contrôle​

Bouton Open full screen​

  • Affiche l'interface du module Integrations en plein écran, ce qui est utile pour travailler sur des flux de données complexes ou présenter un projet sur un grand écran.
  • Vous disposez ainsi de plus d'espace pour l'édition et voyez mieux tous les détails de vos flux.

Bouton Publish​

  • C'est le bouton principal : il enregistre et déploie toutes les modifications apportées à vos flux de données, ce qui les rend actifs. Après avoir ajouté ou modifié des nœuds, cliquez toujours sur ce bouton pour que vos réglages prennent effet.

Bouton Import​

Input Schema et transmission du schéma entre les nœuds​

Dans le formulaire d'édition, chaque nœud affiche un bloc Input Schema : le schéma des données reçues du nœud précédent dans le flux. Il présente les champs disponibles sous forme de paires « clé : type », en tenant compte de l'imbrication des objets.

Si un champ est décrit dans la description de l'API, cette description s'affiche à côté de la clé. L'éditeur de code reprend ces mêmes descriptions pour l'autocomplétion et les infobulles lors de l'écriture de modèles Mustache.

Nœuds qui transmettent le schéma au nœud suivant​

Seuls certains nœuds peuvent transmettre le schéma :

  • Function : le schéma est construit à partir du champ Output Example (JSON). Ce champ sert aussi de données de test lorsque le flux est appelé sans exécution réelle du code Function.
  • Admin API : le schéma provient de la description de la méthode dans la description de l'API. Un clic sur Execute met à jour le schéma avec la réponse réelle de l'API. Les champs qui correspondent à la description de l'API conservent leur description textuelle.
  • Http Request : il n'y a pas de schéma au départ. Il apparaît après un clic sur Execute et provient de la réponse réelle.

Bouton Execute​

Les nœuds Admin API et Http Request proposent un bouton Execute dans le formulaire d'édition. Il exécute toute la chaîne de nœuds, du début du flux jusqu'au nœud actuel.

Particularités :

  • Le serveur exécute le flux dans l'état du dernier Publish : avant de tester, vérifiez que le flux est publié.
  • Si un nœud function sur le chemin ne transmet pas de données, mais que son champ Output Example (JSON) est rempli, cette valeur sert de données de test.
  • Si la réponse aboutit, le résultat est transmis au nœud suivant sous forme de schéma.
  • En cas d'erreur, aucun schéma n'est transmis au nœud suivant.

Appel automatique des nœuds en lecture seule​

Tous les nœuds admin-api qui n'effectuent que des requêtes en lecture (GET) sont appelés automatiquement à l'ouverture de la page Integrations et lors de la mise à jour du flux avec le bouton Publish. Le schéma de données reste ainsi à jour sans lancement manuel.

Dernière mise à jour le