Pular para o conteúdo principal

Nó admin-api

O nó admin-api fornece acesso direto à API interna do OneEntry. Com ele, é possível ler e modificar pedidos, páginas, usuários, coleções e sessões de pagamento diretamente do fluxo de integração — sem a necessidade de escrever requisições HTTP manualmente.

Configurações do nó admin-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 admin-api.

Exemplo:

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

2. Tipo​

Seleção do método da API que será chamado ao passar a mensagem pelo nó. Métodos disponíveis:

  • "Atualizar objeto de página" — Atualização do objeto da página
  • "Pesquisar todos os objetos nas páginas de produtos com paginação para a categoria selecionada" — Pesquisa de produtos com paginação
  • "Mudança de status da página do produto" — Alteração do status da página do produto
  • "Atualização da página do produto" — Atualização da página do produto
  • "Atualização do objeto do usuário - admin" — Atualização do objeto do usuário (por um administrador)
  • "Atualizar um objeto de usuário" — Atualização de um único objeto de usuário
  • "Atualizando o valor de um atributo de entidade" — Atualização do valor do atributo da entidade
  • "Recebendo todos os pedidos pertencentes ao objeto de armazenamento de pedidos" — Recebendo todos os pedidos do armazenamento
  • "Atualizando o status de um pedido pertencente ao objeto de armazenamento de pedidos" — Atualização do status do pedido
  • "Atualização da sessão de pagamento" — Atualização da sessão de pagamento
  • "Recebendo um objeto de sessão de pagamento pelo seu identificador" — Recebendo a sessão de pagamento pelo ID
  • "Criando uma sessão de pagamento" — Criação de uma sessão de pagamento
  • "Recebendo todos os registros pertencentes à coleção" — Recebendo registros da coleção
  • "Criando um registro na coleção" — Criação de um registro na coleção
  • "Mudando um registro na coleção" — Alteração de um registro na coleção
  • "Excluindo um objeto do registro da coleção" — Exclusão de um objeto do registro da coleção

3. Parâmetros de consulta​

Parâmetros da requisição URL. O campo utiliza a sintaxe Mustache — valores de msg podem ser inseridos através de {{variável}}.

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

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

4. Corpo da requisição​

Corpo da requisição no formato JSON. Suporta Mustache para inserção de dados de msg.

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

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

5. Esquema de Entrada​

O bloco Esquema de Entrada é exibido nas configurações do nó e mostra a estrutura dos dados que vêm do nó anterior no fluxo. O esquema é apresentado na forma de pares "chave — tipo", considerando a profundidade dos objetos.

Se os campos do esquema estão descritos no Swagger, descrições textuais são exibidas ao lado deles. Essas mesmas descrições são capturadas pelo editor de código (Monaco) como dicas ao escrever templates Mustache.

Exemplo de exibição do Esquema de Entrada:

payload
  └── order
        ├── id           (integer)  — Identificador do pedido
        ├── status       (string)   — Status atual
        └── totalPrice   (number)   — Valor total

6. Botão Executar​

O botão Executar permite chamar a requisição da API diretamente do formulário de edição do nó, sem precisar executar todo o fluxo.

Como funciona:

  • O servidor executa todo o fluxo desde o início até este nó, passando os dados pela cadeia de acordo com o último estado publicado do fluxo.
  • Se algum nó function ao longo do caminho não passar os dados adiante, mas tiver o campo Exemplo de Saída (JSON) preenchido, esses dados são usados como mock.
  • Em caso de resposta bem-sucedida, a resposta da API é passada para o próximo nó como esquema.
  • Se a requisição retornar um erro — o esquema não é passado para o próximo nó.
info

Antes de usar o botão Executar, certifique-se de que o fluxo está publicado. O servidor executa a cadeia com base no estado da última publicação.

Impacto no esquema:

O nó admin-api inicialmente possui um esquema de resposta do Swagger. Ao clicar em Executar, o esquema é sobrescrito pela resposta real da API. Nesse processo, os campos que coincidem com a descrição do Swagger mantêm suas descrições textuais.

7. Chamada automática de requisições somente leitura​

Todos os nós admin-api que executam requisições apenas de leitura (GET) são chamados automaticamente:

  • ao abrir a página de Integrações,
  • ao atualizar o fluxo através do botão Publicar.

Isso permite sempre ter um esquema de dados atualizado no próximo nó sem a necessidade de execução manual.

Exemplos de uso​

Exemplo 1: Criação de sessão de pagamento​

Configurações do nó:

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

Resultado:
O nó cria uma sessão de pagamento, utilizando orderId da mensagem de entrada, e passa os dados da nova sessão para o próximo nó.

Exemplo 2: Atualização do status do pedido​

Configurações do nó:

  • Tipo: Atualizando o status de um pedido pertencente ao objeto de armazenamento de pedidos
  • Parâmetros de consulta: 
    {
      "id": {{orderId}}
    }
  • Corpo da requisição: 
    {
      "status": "{{newStatus}}"
    }

Resultado:
O nó atualiza o status do pedido, utilizando os dados da mensagem de entrada.

Exemplo 3: Recebendo registros da coleção​

Configurações do nó:

  • Tipo: Recebendo todos os registros pertencentes à coleção
  • Parâmetros de consulta: 
    {
      "entityType": "delivery",
      "entityId": "{{payload.id}}",
      "langCode": "pt_BR",
      "offset": 0,
      "limit": 10
    }

Resultado:
O nó retorna uma lista de registros da coleção. Como esta é uma requisição somente leitura, ao abrir a página, o esquema de resposta é carregado automaticamente.