Passa al contenuto principale

Nodo api

Questo nodo consente di interagire con vari API, utile per l'integrazione con servizi esterni.

Impostazioni del nodo API​

IMG2

1. Nome​

Campo per specificare il nome del nodo.
Il nome viene visualizzato nell'area di lavoro e aiuta a identificare facilmente il nodo.
Se lasciato vuoto, il nodo sarà chiamato API.

Esempio:

  • Nome del nodo: Crea Sessione di Pagamento

2. Metodo​

Qui si seleziona il metodo API che verrà utilizzato per inviare la richiesta. Metodi disponibili:

  • "Crea Sessione di Pagamento":
    Crea una nuova sessione di pagamento.

  • "Aggiorna Sessione di Pagamento":
    Aggiorna una sessione di pagamento esistente.

  • "Ottieni Sessione di Pagamento per ID":
    Ottiene informazioni sulla sessione di pagamento tramite l'identificatore unico della sessione.

  • "Ottieni Sessione di Pagamento per Order ID":
    Ottiene informazioni sulla sessione di pagamento utilizzando l'identificatore dell'ordine.

Esempio:

  • Metodo: Crea Sessione di Pagamento

3. Dati​

Questo campo utilizza il modello Mustache per formare i dati della richiesta in formato JSON.
Puoi utilizzare i dati dal messaggio msg per sostituire i valori nel modello.

Esempio di modello (per il metodo "Crea Sessione di Pagamento"):

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

In questo esempio, il valore orderId sarà sostituito dai dati del messaggio msg.

Esempio di modello (per il metodo "Aggiorna Sessione di Pagamento"):

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

Utilizzando i modelli Mustache, puoi passare dati complessi e parametri necessari per interagire con l'API.

Esempi di richieste​

Esempio 1: Creazione di una sessione di pagamento​

Impostazioni del nodo:

  • Metodo: Crea Sessione di Pagamento
  • Dati: 
    {
      "orderId": {{orderId}},
      "type": "session"
    }

Messaggio:

{
  "orderId": 123
}

Risultato:
Il nodo invierà una richiesta per creare una sessione di pagamento con i dati dal messaggio. Di conseguenza, verranno ottenute informazioni sulla nuova sessione di pagamento.

Esempio 2: Aggiornamento di una sessione di pagamento​

Impostazioni del nodo:

  • Metodo: Aggiorna Sessione di Pagamento
  • Dati: 
    {
      "id": {{paymentSessionId}},
      "paymentUrl": "{{{payload.links.1.href}}}"
    }

Messaggio:

{
  "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"
      }
    ]
  }
}

Risultato:
Il nodo invierà una richiesta per aggiornare lo stato della sessione di pagamento, utilizzando i valori forniti payment_session_id e status.

Esempio 3: Ottenere una sessione di pagamento per ID​

Impostazioni del nodo:

  • Metodo: Ottieni Sessione di Pagamento per ID
  • Dati: 
    {
      "id": "{{paymentSessionId}}"
    }

Messaggio:

{
  "paymentSessionId": 123
}

Risultato:
Il nodo invierà una richiesta per ottenere informazioni sulla sessione di pagamento tramite l'identificatore unico della sessione.

Esempio 4: Ottenere una sessione di pagamento per Order ID​

Impostazioni del nodo:

  • Metodo: Ottieni Sessione di Pagamento per Order ID
  • Dati: 
    {
      "orderId": "{{payload.id}}"
    }

Messaggio:

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

Risultato:
Il nodo invierà una richiesta per ottenere informazioni sulla sessione di pagamento associata all'identificatore dell'ordine specificato.