Aller au contenu principal

Noeud admin-api

Le noeud admin-api fournit un accès direct à l'API interne de OneEntry. Grâce à lui, il est possible de lire et de modifier des commandes, des pages, des utilisateurs, des collections et des sessions de paiement directement depuis le flux d'intégration — sans avoir à écrire manuellement des requêtes HTTP.

Paramètres du noeud admin-api​

IMG2

1. Nom​

Champ pour indiquer le nom du noeud.
Le nom s'affiche dans l'espace de travail et aide à identifier facilement le noeud.
S'il est laissé vide, le noeud sera nommé admin-api.

Exemple :

  • Nom du noeud : Créer une session de paiement

2. Type​

Sélection du méthode API qui sera appelée lors du passage d'un message à travers le noeud. Méthodes disponibles :

  • "Mettre à jour l'objet de page" — Mise à jour de l'objet de page
  • "Rechercher tous les objets sur les pages produits avec pagination pour la catégorie sélectionnée" — Recherche de produits avec pagination
  • "Changer le statut de la page produit" — Changement du statut de la page produit
  • "Mise à jour de la page produit" — Mise à jour de la page produit
  • "Mise à jour de l'objet utilisateur - admin" — Mise à jour de l'objet utilisateur (par un administrateur)
  • "Mettre à jour un objet utilisateur" — Mise à jour d'un objet utilisateur
  • "Mise à jour de la valeur d'un attribut d'entité" — Mise à jour de la valeur d'un attribut d'entité
  • "Recevoir toutes les commandes appartenant à l'objet de stockage de commandes" — Recevoir toutes les commandes du stockage
  • "Mise à jour du statut d'une commande appartenant à l'objet de stockage de commandes" — Mise à jour du statut de la commande
  • "Mise à jour de la session de paiement" — Mise à jour de la session de paiement
  • "Recevoir un objet de session de paiement par son identifiant" — Recevoir la session de paiement par ID
  • "Créer une session de paiement" — Création d'une session de paiement
  • "Recevoir tous les enregistrements appartenant à la collection" — Recevoir les enregistrements de la collection
  • "Créer un enregistrement dans la collection" — Création d'un enregistrement dans la collection
  • "Changer un enregistrement dans la collection" — Modification d'un enregistrement dans la collection
  • "Supprimer un objet de l'enregistrement de la collection" — Suppression d'un objet de l'enregistrement de la collection

3. Paramètres de requête​

Paramètres de la requête URL. Le champ utilise la syntaxe Mustache — les valeurs de msg peuvent être insérées via {{variable}}.

Exemple (pour la méthode "Recevoir tous les enregistrements appartenant à la collection") :

{
  "entityType": "orders",
  "entityId": "{{orderId}}",
  "langCode": "fr_FR",
  "offset": 0,
  "limit": 1,
  "marker": "livraison"
}

4. Corps de la requête​

Corps de la requête au format JSON. Prend en charge Mustache pour l'insertion de données à partir de msg.

Exemple (pour la méthode "Créer une session de paiement") :

{
  "orderId": {{orderId}},
  "type": "session"
}

5. Schéma d'entrée​

Le bloc Schéma d'entrée s'affiche dans les paramètres du noeud et montre la structure des données qui proviennent du noeud précédent dans le flux. Le schéma est présenté sous forme de paires « clé — type », en tenant compte de l'imbrication des objets.

Si les champs du schéma sont décrits dans Swagger, des descriptions textuelles s'affichent à côté d'eux. Ces mêmes descriptions sont récupérées par l'éditeur de code (Monaco) sous forme d'astuces lors de l'écriture de modèles Mustache.

Exemple d'affichage du Schéma d'entrée :

payload
  └── order
        ├── id           (integer)  — Identifiant de la commande
        ├── status       (string)   — Statut actuel
        └── totalPrice   (number)   — Montant total

6. Bouton Exécuter​

Le bouton Exécuter permet d'appeler une requête API directement depuis le formulaire d'édition du noeud, sans lancer le flux dans son ensemble.

Comment cela fonctionne :

  • Le serveur exécute tout le flux depuis le début jusqu'à ce noeud, transmettant les données en chaîne selon l'état le plus récemment publié du flux.
  • Si un noeud function en cours de route ne transmet pas les données plus loin, mais que son champ Exemple de sortie (JSON) est rempli, ces données sont utilisées comme des données fictives.
  • En cas de réponse réussie, la réponse de l'API est transmise au noeud suivant en tant que schéma.
  • Si la requête renvoie une erreur, le schéma n'est pas transmis au noeud suivant.
info

Avant d'utiliser le bouton Exécuter, assurez-vous que le flux est publié. Le serveur exécute la chaîne selon l'état du dernier publish.

Impact sur le schéma :

Le noeud admin-api a initialement un schéma de réponse provenant de Swagger. Lorsque vous cliquez sur Exécuter, le schéma est écrasé par la réponse réelle de l'API. Les champs qui correspondent à la description Swagger conservent leurs descriptions textuelles.

7. Appel automatique des requêtes en lecture seule​

Tous les noeuds admin-api effectuant des requêtes uniquement en lecture (GET) sont appelés automatiquement :

  • lors de l'ouverture de la page Intégrations,
  • lors de la mise à jour du flux via le bouton Publier.

Cela permet d'avoir toujours un schéma de données à jour dans le noeud suivant sans lancement manuel.

Exemples d'utilisation​

Exemple 1 : Création d'une session de paiement​

Paramètres du noeud :

  • Type : Créer une session de paiement
  • Corps de la requête : 
    {
      "orderId": {{orderEvent.order.id}},
      "type": "session"
    }

Résultat :
Le noeud crée une session de paiement, en utilisant orderId du message entrant, et transmet les données de la nouvelle session au noeud suivant.

Exemple 2 : Mise à jour du statut de la commande​

Paramètres du noeud :

  • Type : Mise à jour du statut d'une commande appartenant à l'objet de stockage de commandes
  • Paramètres de requête : 
    {
      "id": {{orderId}}
    }
  • Corps de la requête : 
    {
      "status": "{{newStatus}}"
    }

Résultat :
Le noeud met à jour le statut de la commande, en utilisant les données du message entrant.

Exemple 3 : Obtention des enregistrements de la collection​

Paramètres du noeud :

  • Type : Recevoir tous les enregistrements appartenant à la collection
  • Paramètres de requête : 
    {
      "entityType": "livraison",
      "entityId": "{{payload.id}}",
      "langCode": "fr_FR",
      "offset": 0,
      "limit": 10
    }

Résultat :
Le noeud renvoie une liste d'enregistrements de la collection. Étant donné qu'il s'agit d'une requête en lecture seule, lors de l'ouverture de la page, le schéma de réponse est chargé automatiquement.