Aller au contenu principal

Noeud api

Ce noeud permet d'interagir avec différentes API, ce qui est utile pour l'intégration avec des services externes.

Paramètres du noeud 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 appelé API.

Exemple :

  • Nom du noeud : Create Payment Session

2. Méthode​

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

  • "Create Payment Session" (Créer une session de paiement) :
    Crée une nouvelle session de paiement.

  • "Update Payment Session" (Mettre à jour la session de paiement) :
    Met à jour une session de paiement existante.

  • "Get Payment Session by ID" (Obtenir la session de paiement par ID) :
    Obtient des informations sur la session de paiement par l'identifiant unique de la session.

  • "Get Payment Session by Order ID" (Obtenir la session de paiement par ID de commande) :
    Obtient des informations sur la session de paiement en utilisant l'identifiant de commande.

Exemple :

  • Méthode : Create Payment Session

3. Données​

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

Exemple de modèle (pour la méthode "Create Payment Session") :

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

Dans cet exemple, la valeur orderId sera substituée à partir du message msg.

Exemple de modèle (pour la méthode "Update Payment Session") :

 {
   "id": {{paymentSessionId}},
   "paymentUrl": "{{{payload.links.1.href}}}"
 }

Lors de l'utilisation de modèles Mustache, vous pouvez transmettre des données et des paramètres complexes nécessaires pour interagir avec l'API.

Exemples de requêtes​

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

Paramètres du noeud :

  • Méthode : Create Payment Session
  • Données : 
    {
      "orderId": {{orderId}},
      "type": "session"
    }

Message :

{
  "orderId": 123
}

Résultat :
Le noeud 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 obtenues.

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

Paramètres du noeud :

  • Méthode : Update Payment Session
  • Données : 
    {
      "id": {{paymentSessionId}},
      "paymentUrl": "{{{payload.links.1.href}}}"
    }

Message :

{
  "paymentSessionId": 123,
  "payload": {
    "id": "8YP51523N05861826",
    ....
    "links": [
      {
        "href": "https://api.sandbox.paypal.com/v2/checkout/orders/8YP51523N05861826",
        "rel": "self",
        "method": "GET"
      },
      {
        "href": "https://www.sandbox.paypal.com/checkoutnow?token=8YP51523N05861826",
        "rel": "payer-action",
        "method": "GET"
      }
    ]
  }
}

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

Exemple 3 : Obtenir la session de paiement par ID​

Paramètres du noeud :

  • Méthode : Get Payment Session by ID
  • Données : 
    {
      "id": "{{paymentSessionId}}"
    }

Message :

{
  "paymentSessionId": 123
}

Résultat :
Le noeud enverra une requête pour obtenir des informations sur la session de paiement par l'identifiant unique de la session.

Exemple 4 : Obtenir la session de paiement par ID de commande​

Paramètres du noeud :

  • Méthode : Get Payment Session by Order ID
  • Données : 
    {
      "orderId": "{{payload.id}}"
    }

Message :

{
  "payload": {
    "id": 1
  }
}

Résultat :
Le noeud enverra une requête pour obtenir des informations sur la session de paiement associée à l'identifiant de commande spécifié.