Aller au contenu principal

Node admin-api

Ce nœud permet d'interagir avec diverses API, ce qui est utile pour l'intégration avec des services externes.

Paramètres du nœud admin-api​

IMG2

1. Nom​

Un champ pour spécifier le nom du nœud.
Le nom est affiché dans l'espace de travail et aide à identifier facilement le nœud.
S'il est laissé vide, le nœud sera appelé admin-api.

Exemple :

  • Nom du nœud : Créer une session de paiement

2. Type​

Ici, vous sélectionnez la méthode API qui sera utilisée pour envoyer la requête. Méthodes disponibles :

  • "Mettre à jour l'objet de la page" :

  • "Rechercher tous les objets sur les pages produits avec pagination pour la catégorie sélectionnée" :

  • "Changer le statut de la page produit" :

  • "Mise à jour de la page produit" :

  • "Mise à jour de l'objet utilisateur - admin" :

  • "Mettre à jour un objet utilisateur" :

  • "Mettre à jour la valeur d'un attribut d'entité" :

  • "Recevoir toutes les commandes appartenant à l'objet de stockage de commandes" :

  • "Mettre à jour le statut d'une commande appartenant à l'objet de stockage de commandes" :

  • "Mise à jour de la session de paiement" :

  • "Recevoir un objet de session de paiement par son identifiant" :

  • "Créer une session de paiement" :

  • "Recevoir tous les enregistrements appartenant à la collection" :

  • "Créer un enregistrement dans la collection" :

  • "Changer un enregistrement dans la collection" :

  • "Supprimer un objet de l'enregistrement de la collection" :

3. Paramètres de requête​

Ce champ utilise le modèle Mustache pour former les données de requête au format JSON.
Vous pouvez utiliser des données du message msg pour substituer des valeurs dans le modèle.

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

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

Dans cet exemple, la valeur de orderId sera substituée à partir du message msg.
Lors de l'utilisation de modèles Mustache, vous pouvez passer des données complexes et des paramètres nécessaires pour interagir avec l'API.

4. Corps de la requête​

Ce champ utilise le modèle Mustache pour former les données de requête au format JSON.
Vous pouvez utiliser des données du message msg pour substituer des valeurs dans le modèle.

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

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

Dans cet exemple, la valeur de orderId sera substituée à partir du message msg.
Lors de l'utilisation de modèles Mustache, vous pouvez passer des données complexes et des paramètres nécessaires pour interagir avec l'API.

Exemples de requêtes​

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

Paramètres du nœud :

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

Résultat :
Le nœud enverra une requête pour créer une session de paiement avec les données du message. En conséquence, des informations sur la nouvelle session de paiement seront reçues.

Exemple 2 : Mise à jour d'une session de paiement​

Paramètres du nœud :

  • Type : Mise à jour de la session de paiement
  • Paramètres de requête : 
    {
      "id": {{paymentSessionId}}
    }
  • Corps de la requête : 
    {
      "status": "{{status}}"
    }

Résultat :
Le nœud enverra une requête pour mettre à jour le statut de la session de paiement, en utilisant les valeurs fournies paymentSessionId et status.