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 produits, 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 de l'opération API qui sera appelée lors du passage d'un message à travers le noeud. C'est une liste déroulante avec recherche : les opérations sont regroupées par sections de l'API, et leurs noms sont tirés de la description de l'API du noeud dans la langue de l'interface. Si aucune traduction n'est disponible dans cette langue, les noms sont affichés dans la langue d'origine.

L'ensemble des opérations dépend de la version de OneEntry, donc pour la liste exacte, consultez la liste déroulante Type. Les opérations couvrent :

  • pages et produits — par exemple, "Mise à jour de l'objet Page", "Recherche de tous les objets de page produit avec pagination et filtres.", récupération de plusieurs produits par identifiants ;
  • utilisateurs — y compris la recherche d'utilisateurs ;
  • valeurs d'attributs — y compris la mise à jour des valeurs d'attributs de plusieurs entités à la fois ;
  • commandes — modification du statut de la commande, application d'un déclencheur de statut, retours ;
  • sessions de paiement — par exemple, "Création de session de paiement" et "Mise à jour de session de paiement" ;
  • solde de bonus — ajustement manuel du solde de l'utilisateur ;
  • enregistrements de collections — par exemple, "Récupération de tous les enregistrements appartenant à une collection.".

Après avoir sélectionné une opération, les champs Paramètres de requête et Corps de la requête sont remplis avec un exemple de la description de l'API — il ne reste plus qu'à insérer vos valeurs.

3. Paramètres de requête​

Paramètres de la requête. Le chemin et la méthode HTTP sont automatiquement pris par le noeud à partir de l'opération sélectionnée, ils ne peuvent pas être modifiés dans le formulaire. Les valeurs des paramètres de chemin (par exemple, l'identifiant de l'enregistrement) sont définies dans ce même champ avec les paramètres de l'URL de la requête.

Le champ utilise la syntaxe Mustache — les valeurs de msg peuvent être insérées via {{variable}}.

Exemple (pour l'opération "Récupération de tous les enregistrements appartenant à une 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. Le champ n'est affiché que pour les opérations avec les méthodes POST, PUT et PATCH. Il prend en charge Mustache pour l'insertion de données à partir de msg.

Exemple (pour l'opération "Création de 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 des champs du schéma sont présents dans la description de l'API, des descriptions textuelles s'affichent à côté d'eux. Ces mêmes descriptions sont récupérées par l'éditeur de code sous forme d'indices 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 intégralité.

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 sur le chemin ne transmet pas de données plus loin, mais que son champ Exemple de sortie (JSON) est rempli, ces données sont utilisées comme test.
  • 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 la description de l'API. Lors de l'appui sur Exécuter, le schéma est écrasé par la réponse réelle de l'API. Les champs qui correspondent à la description de l'API 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éation de 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 : Récupération des enregistrements d'une collection​

Paramètres du noeud :

  • Type : Récupération de tous les enregistrements appartenant à une 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. Comme 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.