Automação e produtividade · tutorial

Como ligar uma API ao n8n com HTTP Request

Para ligar uma API ao n8n, identifica a operação na documentação do serviço e configura o nó HTTP Request com o método, o endereço e a autenticação correspondentes. Começa por uma leitura pequena. Confirma os campos devolvidos antes de acrescentares transformações, gravações ou decisões automáticas ao workflow.

Dois módulos API e HTTP Request ligados por um canal com um documento em trânsito. Ilustração gerada com IA.
Ilustração gerada com IA para o Laboratório da IA.

Ter um conector pronto facilita o trabalho, mas nem todas as operações de uma ferramenta aparecem nos seus nós. Às vezes precisas de consultar um campo adicional, usar uma pesquisa específica ou integrar um serviço que ainda não tem conector. É aí que saber fazer um pedido HTTP se torna útil.

Vamos começar com uma consulta pública ao repositório do n8n no GitHub. O exercício permite observar dados reais sem introduzir uma chave, alterar ficheiros ou criar registos. Depois vais perceber o que muda quando trabalhas com uma API autenticada e quando passas da leitura para uma escrita.

O que precisas de saber antes de configurar o pedido?

Precisas de definir o resultado pretendido, encontrar a operação que o permite e perceber o formato da resposta. A documentação deve indicar o endereço, o método, os parâmetros e os requisitos de acesso. Guarda também um exemplo do resultado esperado. Essa preparação permite distinguir um pedido bem configurado de uma resposta apenas aparentemente útil.

Começa pela pergunta que o workflow deve responder. «Consultar o nome e a página de um repositório» é suficientemente concreto para este exercício. «Ligar o GitHub» deixa em aberto centenas de possibilidades e não te dá um critério para saber quando terminaste.

Nas unidades do Laboratório sobre HTTP Request e APIs, a preparação passa por consultar o contrato do serviço antes de preencher o nó. Aplica essa sequência mesmo quando um assistente de IA te entrega uma configuração pronta. Um endereço plausível e uma lista de campos bem apresentada podem não corresponder a uma operação existente.

Abre a página oficial da operação e confirma que estás a ler documentação adequada ao serviço e à versão que utilizas. Se o exemplo exigir permissões que não tens, procura a operação correta ou ajusta o âmbito do exercício. Não precisas de obter acesso administrativo para aprender a consultar informação pública.

Se ainda estás a decidir quais os passos do processo, começa por desenhar a automação antes de abrir o n8n. O pedido HTTP deve resolver uma necessidade identificada nesse desenho, como obter a informação que falta para preencher uma tabela ou tomar uma decisão.

Como preparas a primeira consulta pública no n8n?

Cria um workflow de teste e acrescenta um HTTP Request. Neste exercício, vais consultar os metadados públicos de um único repositório, usando GET e sem autenticação. Mantém o pedido isolado de ações de escrita. Assim, consegues estudar a resposta e corrigir a configuração sem produzir efeitos noutras ferramentas.

Na referência de repositórios do GitHub, a operação de consulta usa o proprietário e o nome do repositório no caminho. Para o exemplo, preenche o método com GET e o URL com `https://api.github.com/repos/n8n-io/n8n`. Seleciona a opção sem autenticação, pois a consulta é a um recurso público.

Ativa o envio de cabeçalhos e acrescenta `Accept` com o valor `application/vnd.github+json`, recomendado pelo GitHub. Não acrescentes um corpo ao pedido. Executa o nó e procura na resposta os campos `full_name`, `html_url` e `description`. O primeiro permite confirmar que recebeste o repositório pretendido.

Este endereço foi conferido na revisão do artigo e devolveu o recurso público esperado. Essa observação confirma o exemplo nessa data; não elimina a possibilidade de uma falha de rede ou de um limite de utilização quando fizeres o teu teste. Lê sempre o resultado da tua própria execução.

O objetivo inicial fica cumprido quando consegues identificar esses campos e explicar a sua utilidade. Não precisas de interpretar toda a resposta. A presença de muitos valores é uma oportunidade para escolher o que interessa, e não uma obrigação de transportar tudo para as etapas seguintes.

Como distingues endereço, parâmetros, cabeçalhos e corpo?

O endereço identifica a operação, os parâmetros ajustam a consulta, os cabeçalhos transportam informação sobre o pedido e o corpo pode transportar os dados enviados. O papel concreto de cada elemento depende da API. Preenche apenas o que a operação documenta e evita deslocar valores entre campos por tentativa.

No exercício, `n8n-io` e `n8n` fazem parte do caminho do endereço. Já um filtro de pesquisa, quando previsto por outra operação, pode surgir nos parâmetros da consulta. Uma descrição que pretendes guardar pode pertencer ao corpo de uma operação de escrita. Esses elementos não são intercambiáveis.

A documentação de HTTP Request descreve os campos de configuração e os formatos aceites. Quando passares para outra API, compara a documentação dessa operação com os campos do nó. A escolha entre JSON, formulário e ficheiro deve seguir o contrato do destino.

Uma boa prática de aprendizagem é escrever uma pequena ficha antes de executar: operação pretendida, valor introduzido e origem desse valor na documentação. Se não consegues explicar porque colocaste um campo, retira-o da primeira tentativa ou procura a justificação. Acrescentar opções desnecessárias torna o diagnóstico mais difícil.

Mantém também a distinção entre um exemplo e um valor real. Um identificador ilustrativo copiado de uma página de ajuda não passa a identificar um objeto da tua conta. Quando a operação depende de um recurso específico, confirma primeiro que o identificador pertence ao ambiente onde estás a trabalhar.

O que muda quando a API exige autenticação?

Numa API autenticada, precisas de uma credencial válida com permissões para a operação escolhida. Guarda essa credencial no mecanismo próprio do n8n e associa-a ao pedido. O método de autenticação vem da documentação do serviço. Ter uma chave não significa poder executar todas as operações disponíveis nessa API.

A documentação de credenciais HTTP recomenda usar um tipo predefinido quando existe para o serviço. Para outros casos, apresenta opções genéricas, incluindo autenticação por cabeçalho, Bearer e OAuth. Escolhe a opção correspondente ao serviço; não transformes automaticamente qualquer chave num token Bearer.

Para o primeiro teste autenticado, procura uma leitura pequena e autorizada. Anota qual a conta, o ambiente e a finalidade da credencial, sem copiar o segredo para essa nota. Se a ferramenta distingue teste e produção, mantém essa diferença visível nos nomes que atribuis às ligações.

Quando pedires ajuda, mostra os nomes dos campos e o erro com os valores sensíveis removidos. Não precisas de publicar a chave para explicar que a autenticação falhou. Também deves rever capturas de ecrã e exemplos copiados de pedidos, porque podem incluir dados que não estão visíveis à primeira vista.

Antes de reutilizares uma credencial noutra integração, confirma o destino. Um pedido preparado para um fornecedor não deve passar a enviar autenticação para um endereço arbitrário recebido num formulário. No teu exercício, define explicitamente o serviço permitido e mantém o endereço sob controlo do workflow.

Sequência ilustrada de pedido, resposta, verificação e destino, com destaque para a inspeção dos dados recebidos. Imagem gerada com IA.
Sequência ilustrada de pedido, resposta, verificação e destino, com destaque para a inspeção dos dados recebidos. Imagem gerada com IA. Ilustração gerada com IA.

Como confirmas que a resposta contém o que precisas?

Compara a resposta com o resultado esperado, verificando identidade, campos, tipos e ausência de informação essencial. Um pedido terminado sem erro não demonstra que os dados servem o processo. Escolhe uma amostra que conheces e segue os valores até à etapa seguinte, para confirmar que o mapeamento conserva o significado.

No exemplo do GitHub, compara `full_name` com `n8n-io/n8n` e abre a página indicada em `html_url` para reconhecer o recurso. Não uses o número de campos como medida de qualidade. Para uma pequena ficha de consulta, o nome, a descrição e a ligação podem ser suficientes.

Se quiseres observar o estado HTTP e os cabeçalhos, a opção Include Response Headers and Status permite incluí-los na saída. Essa alteração pode modificar o caminho pelo qual acedes ao corpo da resposta. Confere a estrutura recebida antes de reaproveitares expressões construídas na configuração anterior.

Usa uma grelha simples para rever a informação antes de a enviar para outro destino.

VerificaçãoPergunta que deves conseguir responder
IdentidadeEste é o recurso que pedi?
CamposTenho os valores necessários ao processo?
TipoO valor chega como texto, número, lista ou objeto?
AusênciaO que faço quando um campo vem vazio?
MapeamentoO próximo nó recebe os valores desta execução?

Num workflow comercial, esta revisão evita erros discretos: trocar o identificador pelo nome, usar um valor fixo do primeiro teste ou interpretar um campo vazio como autorização para continuar. Define o comportamento perante essas situações antes de acrescentares uma etapa de IA que resuma ou classifique a resposta.

Como evitas perder resultados por causa da paginação?

Quando uma operação devolve uma lista, confirma se existem páginas adicionais e como são pedidas. Uma resposta com vários registos pode representar apenas a primeira parte do conjunto. Define um critério de fim e verifica a cobertura. Não concluas que importaste tudo apenas porque o primeiro pedido terminou com sucesso.

A consulta de um único repositório usada neste artigo não precisa de paginação. A questão surge quando trocas essa operação por uma listagem, por exemplo para obter vários recursos. Essa mudança exige ler a documentação da nova operação, em vez de acrescentar um parâmetro chamado «página» por suposição.

O guia de paginação do n8n explica que as APIs podem devolver uma ligação seguinte ou exigir a atualização de um parâmetro. Identifica o mecanismo concreto, os limites por página e o sinal que indica que já não há resultados adicionais.

Para testar a cobertura, escolhe um conjunto pequeno cujo tamanho conheces. Regista os identificadores recebidos em cada página e verifica se faltam elementos ou se aparecem repetições. Se os dados podem mudar durante a consulta, documenta essa limitação e avalia como reconciliar alterações entre o início e o fim.

O mesmo cuidado aplica-se a uma primeira importação seguida de atualizações por eventos. Nas unidades do Laboratório sobre APIs e webhooks, a reconciliação entre histórico e novos eventos faz parte do desenho. Preserva identificadores estáveis e define como reconhecer algo já tratado, sem assumir que a ordem de chegada será sempre perfeita.

Como investigas um erro sem repetir pedidos às cegas?

Regista a execução, a etapa, a mensagem e o resultado observado no serviço. Formula uma hipótese e altera um elemento de cada vez. Confirma o efeito antes de repetir. Essa sequência ajuda a distinguir problemas de configuração, acesso, limites e disponibilidade, sem transformar uma tentativa de diagnóstico numa sucessão de ações difíceis de reconstruir.

A página de problemas comuns do HTTP Request relaciona erros com parâmetros inválidos, endereços incorretos, permissões e limites. Usa essas categorias como ponto de partida, juntamente com a mensagem específica do serviço. O mesmo número de erro pode exigir contexto adicional.

No GitHub, uma consulta pública também está sujeita a limites de pedidos. Se encontrares um limite, respeita a informação de espera disponibilizada pelo serviço. Repetir imediatamente muitas vezes pode prolongar o problema e não te ensina nada sobre a configuração original.

Evita ativar Never Error apenas para fazer desaparecer o estado de falha. Essa opção faz o nó tratar qualquer código como sucesso de execução, exigindo que o teu workflow interprete explicitamente a resposta. Sem essa verificação, uma mensagem de erro pode seguir para o destino como se fosse o registo pedido.

Nas aulas do Laboratório sobre workflows, a análise da execução distingue os dados daquela tentativa da configuração atual. Conserva essa disciplina: escreve o que mudaste e qual foi o resultado. Se pedires apoio, uma descrição concreta permite investigar a causa com muito menos adivinhação do que «a API não funciona».

Quando podes integrar o pedido num processo real?

Integra o pedido depois de confirmares a leitura, os campos necessários, o tratamento de falhas e a responsabilidade pela manutenção. Antes de qualquer escrita, define um destino de teste e verifica o efeito de repetir a operação. Documenta o resultado esperado para que outra pessoa consiga reconhecer uma execução correta.

Podes evoluir o exercício para uma pequena tabela de recursos consultados, guardando apenas os campos escolhidos e a data da consulta. Essa etapa já exige decidir o que acontece quando o mesmo recurso volta a aparecer: atualizar o registo, manter histórico ou ignorar uma repetição, conforme o objetivo.

Se a API permitir criar contactos, enviar mensagens ou alterar encomendas, prepara testes específicos para essas operações. Uma resposta perdida por timeout não prova que a escrita falhou. Confirma o estado no destino antes de reenviar e usa os mecanismos de prevenção de duplicados que o serviço documenta.

O artigo sobre receber formulários e organizar pedidos no n8n mostra como acompanhar o efeito de cada etapa. Podes aplicar o mesmo princípio quando substituíres um conector por HTTP Request: o resultado útil continua a ser um pedido correto e consultável no destino.

Como podes aprender integrações por API no Laboratório da IA?

No Laboratório da IA, podes trabalhar os fundamentos de APIs, webhooks e HTTP Request com apoio ao teu processo de aprendizagem. As aulas semanais e os Zooms de acompanhamento semanais permitem esclarecer dificuldades concretas. Traz a operação pretendida, a documentação e uma execução de teste com os dados sensíveis removidos.

Começa por conseguir explicar o pedido que construíste e verificar a resposta. A partir dessa base, vais estar melhor preparado para ligar ferramentas, organizar dados e acrescentar IA onde ela resolve uma necessidade real do teu workflow.

Passa à prática

Aprende a construir isto no Lab.

Trabalha o processo com aulas, materiais e acompanhamento. Leva o que estás a construir e esclarece as dúvidas da tua implementação.

  • Configurar e conferir um pedido de leitura antes de integrar uma API.
  • Reconhecer falhas de autenticação, mapeamento e cobertura dos resultados.
  • Trazer uma execução de teste para esclarecer dúvidas nos Zooms semanais.

Aulas semanais para aprender e aplicar. Zooms de acompanhamento semanais para esclarecer dúvidas. Replay e materiais para retomar o trabalho ao teu ritmo.

Entrar no Laboratório da IA

Continua a aprender

Como criar um workflow que recebe um formulário e organiza os pedidosComo desenhar uma automação antes de abrir o n8nComo escolher o primeiro processo para automatizar no teu negócio