Aller au contenu principal

Nœud admin-api

Le nœud admin-api donne un accès direct à l'API interne de OneEntry. Il vous permet de lire et de modifier des commandes, des pages, des produits, des utilisateurs, des collections et des sessions de paiement depuis le flux d'intégration, sans écrire de requêtes HTTP à la main.

Paramètres du nœud admin-api​

Panneau « Node Information » du nœud admin-api : bouton "Execute", champs "Name", "Type", "Query parameters" et "Request body".

1. Name​

Nom du nœud.
Il s'affiche dans l'espace de travail et vous aide à identifier le nœud.
Si vous laissez le champ vide, le nœud s'appelle admin-api.

Exemple :

  • Nom du nœud : Create Payment Session

2. Type​

Opération de l'API que le nœud appelle lorsqu'un message le traverse. C'est une liste déroulante avec recherche. Les opérations sont regroupées par section de l'API, et leurs noms proviennent de la description de l'API du nœud, dans la langue de l'interface. S'il n'existe pas de traduction dans cette langue, les noms s'affichent dans la langue d'origine.

Les opérations disponibles dépendent de la version de OneEntry : consultez la liste déroulante Type pour en connaître la liste exacte. Les opérations couvrent :

  • les pages et les produits : par exemple "Page object update", "Searching for all product page objects with pagination and filters.", ou la récupération de plusieurs produits par identifiant ;
  • les utilisateurs : notamment la recherche d'utilisateurs ;
  • les valeurs d'attributs : notamment la mise à jour des valeurs d'attributs de plusieurs entités à la fois ;
  • les commandes : changement du statut d'une commande, application d'un déclencheur de statut, retours ;
  • les sessions de paiement : par exemple "Payment session creation" et "Payment session update" ;
  • le solde de bonus : ajustement manuel du solde d'un utilisateur ;
  • les enregistrements de collections : par exemple "Retrieving all records belonging to a collection.".

Une fois l'opération choisie, les champs Query parameters et Request body sont préremplis avec un exemple tiré de la description de l'API. Il ne vous reste qu'à y mettre vos propres valeurs.

3. Query parameters​

Paramètres de la requête. Le nœud reprend automatiquement le chemin et la méthode HTTP de l'opération sélectionnée ; vous ne pouvez pas les modifier dans le formulaire. Les valeurs des paramètres de chemin (par exemple l'identifiant d'un enregistrement) se saisissent dans ce même champ, avec les paramètres de requête de l'URL.

Le champ utilise la syntaxe Mustache : vous pouvez y insérer des valeurs de msg avec {{variable}}.

Exemple (pour l'opération "Retrieving all records belonging to a collection.") :

{
  "entityType": "orders",
  "entityId": "{{orderId}}",
  "langCode": "en_US",
  "offset": 0,
  "limit": 1,
  "marker": "delivery"
}

4. Request body​

Corps de la requête au format JSON. Le champ ne s'affiche que pour les opérations qui utilisent la méthode POST, PUT ou PATCH. Il accepte Mustache pour insérer des données de msg.

Exemple (pour l'opération "Payment session creation") :

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

5. Input Schema​

Le bloc Input Schema, dans les paramètres du nœud, montre la structure des données reçues du nœud précédent du flux. Le schéma se présente sous forme de paires clé/type et reflète l'imbrication des objets.

Lorsqu'un champ du schéma figure dans la description de l'API, sa description textuelle s'affiche à côté. L'éditeur de code reprend aussi ces descriptions sous forme d'indications lorsque vous écrivez des modèles Mustache.

Exemple d'affichage de l'Input Schema :

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

6. Bouton Execute​

Le bouton Execute vous permet d'appeler la requête API directement depuis le formulaire d'édition du nœud, sans exécuter tout le flux.

Fonctionnement :

  • Le serveur exécute le flux depuis son début jusqu'à ce nœud et transmet les données le long de la chaîne selon le dernier état publié du flux.
  • Si un nœud function du chemin ne transmet pas de données mais que son champ Output Example (JSON) est renseigné, ces données servent de données de test.
  • Si la requête aboutit, la réponse de l'API est transmise au nœud suivant comme schéma.
  • Si la requête renvoie une erreur, aucun schéma n'est transmis au nœud suivant.
info

Avant d'utiliser le bouton Execute, vérifiez que le flux est publié. Le serveur exécute la chaîne dans l'état du dernier publish.

Effet sur le schéma :

Au départ, le nœud admin-api a le schéma de réponse issu de la description de l'API. Un clic sur Execute remplace ce schéma par la réponse réelle de l'API. Les champs qui correspondent à la description de l'API conservent leur description textuelle.

7. Appel automatique des requêtes 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 ;
  • à la mise à jour du flux avec le bouton Publish.

Le nœud suivant dispose ainsi toujours d'un schéma de données à jour, sans exécution manuelle.

Exemples d'utilisation​

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

Paramètres du nœud :

  • Type : Payment session creation
  • Request body : 
    {
      "orderId": {{orderEvent.order.id}},
      "type": "session"
    }

Résultat :
Le nœud crée une session de paiement à partir de l'orderId du message entrant et transmet les données de la nouvelle session au nœud suivant.

Exemple 2 : mise à jour du statut d'une commande​

Paramètres du nœud :

  • Type : Updating the status of an order belonging to the order storage object
  • Query parameters : 
    {
      "id": {{orderId}}
    }
  • Request body : 
    {
      "status": "{{newStatus}}"
    }

Résultat :
Le nœud met à jour le statut de la commande à partir des données du message entrant.

Exemple 3 : récupération des enregistrements d'une collection​

Paramètres du nœud :

  • Type : Retrieving all records belonging to a collection.
  • Query parameters : 
    {
      "entityType": "delivery",
      "entityId": "{{payload.id}}",
      "langCode": "en_US",
      "offset": 0,
      "limit": 10
    }

Résultat :
Le nœud renvoie la liste des enregistrements de la collection. Comme il s'agit d'une requête en lecture seule, le schéma de réponse se charge automatiquement à l'ouverture de la page.

Dernière mise à jour le