Pular para o conteúdo principal

Nó api

Este nó permite interagir com várias APIs, o que é útil para integração com serviços externos.

Configurações do nó API​

IMG2

1. Nome​

Campo para especificar o nome do nó.
O nome é exibido na área de trabalho e ajuda a identificar facilmente o nó.
Se deixado em branco, o nó será chamado de API.

Exemplo:

  • Nome do nó: Create Payment Session

2. Método​

Aqui você escolhe o método da API que será usado para enviar a solicitação. Métodos disponíveis:

  • "Create Payment Session" (Criar sessão de pagamento):
    Cria uma nova sessão de pagamento.

  • "Update Payment Session" (Atualizar sessão de pagamento):
    Atualiza uma sessão de pagamento existente.

  • "Get Payment Session by ID" (Obter sessão de pagamento por ID):
    Obtém informações sobre a sessão de pagamento pelo identificador único da sessão.

  • "Get Payment Session by Order ID" (Obter sessão de pagamento por ID do pedido):
    Obtém informações sobre a sessão de pagamento usando o identificador do pedido.

Exemplo:

  • Método: Create Payment Session

3. Dados​

Este campo usa o modelo Mustache para formar os dados da solicitação no formato JSON.
Você pode usar dados da mensagem msg para substituir valores no modelo.

Exemplo de modelo (para o método "Create Payment Session"):

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

Neste exemplo, o valor orderId será substituído pela mensagem msg.

Exemplo de modelo (para o método "Update Payment Session"):

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

Ao usar modelos Mustache, você pode passar dados e parâmetros complexos necessários para interagir com a API.

Exemplos de solicitações​

Exemplo 1: Criar sessão de pagamento​

Configurações do nó:

  • Método: Create Payment Session
  • Dados: 
    {
      "orderId": {{orderId}},
      "type": "session"
    }

Mensagem:

{
  "orderId": 123
}

Resultado:
O nó enviará uma solicitação para criar uma sessão de pagamento com os dados da mensagem. Como resultado, informações sobre a nova sessão de pagamento serão obtidas.

Exemplo 2: Atualizar sessão de pagamento​

Configurações do nó:

  • Método: Update Payment Session
  • Dados: 
    {
      "id": {{paymentSessionId}},
      "paymentUrl": "{{{payload.links.1.href}}}"
    }

Mensagem:

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

Resultado:
O nó enviará uma solicitação para atualizar o status da sessão de pagamento, usando os valores fornecidos payment_session_id e status.

Exemplo 3: Obter sessão de pagamento por ID​

Configurações do nó:

  • Método: Get Payment Session by ID
  • Dados: 
    {
      "id": "{{paymentSessionId}}"
    }

Mensagem:

{
  "paymentSessionId": 123
}

Resultado:
O nó enviará uma solicitação para obter informações sobre a sessão de pagamento pelo identificador único da sessão.

Exemplo 4: Obter sessão de pagamento por ID do pedido​

Configurações do nó:

  • Método: Get Payment Session by Order ID
  • Dados: 
    {
      "orderId": "{{payload.id}}"
    }

Mensagem:

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

Resultado:
O nó enviará uma solicitação para obter informações sobre a sessão de pagamento associada ao identificador do pedido especificado.