Solicitação Externa - API

Com solicitações externas, você pode chamar APIs de terceiros ou do seu próprio servidor para solicitar dados, enviar dados e etc.

2026-08-11

Em uma etapa de Ação, encontre "Solicitação Externa" em "Ações Avançadas" e clique em "Adicionar sua solicitação" e comece a editá-la:

  • escolha um tipo de solicitação como GET, POST, etc.
  • cole o URL/endpoint da sua solicitação
  • ajuste a seção "Parâmetros de URL", "Cabeçalhos", "Corpo" ou "Autorização", se necessário. por exemplo, configurar chave de API
  • clique em "Teste" e a área 5 será exibida na seção "Resposta" com um código de resposta
  • clique em "Cabeçalhos de resposta" para expandir o cabeçalho para mais detalhes e os dados recebidos ficam em azul
  • escolha qual parte dos dados você precisa clicando no círculo no lado esquerdo de acordo
  • após clicar na área 6, o caminho JSON para os dados selecionados é mostrado automaticamente aqui. $ significa todo o JSON.
  • escolha qual campo personalizado armazenar os dados. Você pode criar um novo campo aqui digitando um nome de campo e clicando nele no menu suspenso. Clique no botão "Adicionar" para adicionar à lista de mapeamento
  • por fim, o mapeamento é exibido na área 9. Adicione quantos mapeamentos forem necessários e clique em "Salvar".
Atenção
Valor de teste - Certifique-se de fornecer dados de teste para qualquer um dos campos/variáveis nas configurações antes de usar o botão Testar.

Parâmetros de URL

Na captura de tela acima, podemos ver que existe um parâmetro de URL no endpoint chamado “user_name”. Lembre-se de copiar o endpoint e fornecer um valor de teste.

Alternativamente, você pode usar as seções URL Params para o mesmo resultado.

Cabeçalhos

Assim como URL Params, coloque o nome da chave primeiro, depois insira a variável e forneça um valor de teste.

Autorização

Alternativamente, coloque o token na seção Autorização. Será menos sujeito a erros (às vezes as pessoas simplesmente esquecem o “Urso” na frente do token).

Além disso, para Basic Auth, basta colocar o valor do seu nome de usuário e senha e o sistema fará a codificação base64 para você.

Corpo

Para incluir um arquivo nos parâmetros, use multipart/form-data:

x-www-for-urlencoded funciona exatamente como parâmetros de URL ou seção de cabeçalhos.

Em vez de listar todas as cargas em x-www-form-urlencoded, você também pode colar a carga de exemplo em JSON bruto:

No lado esquerdo, Body Content, cole ou escreva seu JSON primeiro, quando você insere uma variável, o conteúdo do corpo do teste é exibido imediatamente no lado direito. É para especificar um valor JSON de teste.

Clique em Copiar do conteúdo do corpo para copiar toda a estrutura JSON. Todas as variáveis serão substituídas por {{ variable_name}}. Remova o espaço reservado e coloque seus valores de teste.

Teste

Quando estiver pronto, clique no botão Testar próximo ao endpoint da URL ou na seção Resposta.

Além das dicas sobre como mapear dados acima, você também pode salvar os valores no cabeçalho de resposta para uso posterior. Basta expandir o cabeçalho, clicar em um valor no cabeçalho e o caminho JSON para ele será exibido automaticamente lá.