Pular para o conteúdo principal

Node admin-api

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

Configurações do Nó admin-api​

IMG2

1. Nome​

Um campo para especificar o nome do nó.
O nome é exibido no espaço de trabalho e ajuda a identificar facilmente o nó.
Se deixado em branco, o nó será chamado de admin-api.

Exemplo:

  • Nome do nó: Criar Sessão de Pagamento

2. Tipo​

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

  • "Atualizar objeto de página":

  • "Buscar todos os objetos nas páginas de produtos com paginação para a categoria selecionada":

  • "Alterar o status da página do produto":

  • "Atualização da página do produto":

  • "Atualização do objeto de usuário - admin":

  • "Atualizar um objeto de usuário":

  • "Atualizando o valor de um atributo de entidade":

  • "Recebendo todos os pedidos pertencentes ao objeto de armazenamento de pedidos":

  • "Atualizando o status de um pedido pertencente ao objeto de armazenamento de pedidos":

  • "Atualização da sessão de pagamento":

  • "Recebendo um objeto de sessão de pagamento pelo seu identificador":

  • "Criando uma sessão de pagamento":

  • "Recebendo todos os registros pertencentes à coleção":

  • "Criando um registro na coleção":

  • "Alterando um registro na coleção":

  • "Excluindo um objeto do registro da coleção":

3. Parâmetros de consulta​

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

Exemplo de template (para o método "Recebendo todos os registros pertencentes à coleção"):

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

Neste exemplo, o valor de orderId será substituído pela mensagem msg.
Ao usar templates Mustache, você pode passar dados complexos e parâmetros necessários para interagir com a API.

4. Corpo da solicitação​

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

Exemplo de template (para o método "Criando uma sessão de pagamento"):

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

Neste exemplo, o valor de orderId será substituído pela mensagem msg.
Ao usar templates Mustache, você pode passar dados complexos e parâmetros necessários para interagir com a API.

Exemplos de Solicitação​

Exemplo 1: Criando uma Sessão de Pagamento​

Configurações do nó:

  • Tipo: Criando uma sessão de pagamento
  • Corpo da solicitação: 
    {
      "orderId": {{orderEvent.order.id}},
      "type": "session"
    }

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 recebidas.

Exemplo 2: Atualizando uma Sessão de Pagamento​

Configurações do nó:

  • Tipo: Atualização da sessão de pagamento
  • Parâmetros de consulta: 
    {
      "id": {{paymentSessionId}}
    }
  • Corpo da solicitação: 
    {
      "status": "{{status}}"
    }

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