Como usar uma API com o n8n em uma configuração auto-hospedada?

Integrar uma API com o n8n pode parecer complicado, já que cada provedor tem seus próprios requisitos para conexão. Mas, com o fluxo de trabalho simplificado do n8n, é possível criar um pipeline de dados eficiente e fácil de gerenciar, que pode ser usado em várias automações.

Aqui estão as 10 etapas principais para integrar uma API no seu fluxo de trabalho do n8n:

1. Configurar o n8n em um servidor privado
2. Habilitar o acesso à API
3. Autenticar a chamada da API
4. Testar se a API funciona corretamente
5. Adicionar o endpoint da API ao n8n
6. Inserir um nó de gatilho no seu fluxo de trabalho
7. Criar o fluxo usando outros nós
8. Ajustar as configurações e a lógica de dados
9. Testar seu fluxo de trabalho
10. Garantir a segurança do fluxo

Lembre-se de que, para um fluxo de trabalho realmente eficiente, é importante garantir a segurança e escalabilidade dele ao longo do tempo. Uma forma de facilitar a manutenção do seu fluxo é usar o nó OneSimpleAPI, que já vem com endpoints de API prontos para tarefas simples e pode ser gerenciado diretamente no n8n, sem precisar de APIs de terceiros.

Siga lendo para saber mais sobre como integrar APIs no n8n, dicas de segurança e alguns cenários comuns de uso.

Como usar uma API com o n8n, passo a passo

Nesta seção, vamos detalhar todos os passos para integrar uma API à sua instância do n8n.

1. Configure sua instância auto-hospedada do n8n

Antes de criar um fluxo de trabalho e integrar uma API, você precisa configurar sua instância do n8n. Neste tutorial, vamos focar na versão auto-hospedada, pois ela oferece mais controle e é mais acessível do que o plano oficial.

Para auto-hospedar o n8n, você precisará de um plano de hospedagem com servidor privado virtual (VPS). Você pode usar qualquer provedor, desde que ofereça recursos de hardware suficientes para garantir que seu fluxo de trabalho seja executado de forma responsiva e eficiente.

Como estamos criando um fluxo simples, um servidor com 1 vCPU e 1 GB de RAM já é suficiente. Porém, se você planeja criar múltiplos cenários de automação, precisará de mais recursos.

Os passos para instalar o n8n são os mesmos, independentemente do provedor de VPS. No entanto, recomendamos o plano de hospedagem n8n da Hostinger se você quiser uma configuração simples e sem a necessidade de comandos.

Após adquirir o plano de hospedagem n8n da Hostinger, nosso sistema escolherá automaticamente o template n8n para o seu servidor. A partir daí, basta seguir o processo de onboarding do VPS, que envolve tarefas básicas como configurar o hostname e a senha de root.

Se você já tem um VPS da Hostinger, pode instalar o n8n a qualquer momento com um clique usando o template do sistema operacional. Antes de seguir este procedimento, faça backup dos seus arquivos, pois todos os dados existentes serão apagados. Veja como instalar o n8n no seu servidor:

1. No hPanel, navegue até a barra lateral e clique em VPS.
2. Clique em Gerenciar no VPS onde deseja instalar o n8n.
3. Vá para a barra lateral → SO & Painel → Sistema Operacional.

4. No menu de Sistema Operacional do hPanel, vá até a aba Aplicativos e selecione n8n.

5. Clique em Alterar SO.
6. Confirme a exclusão dos dados e clique em Próximo.
7. Defina uma nova senha de root e clique em Confirmar.

Após a conclusão da instalação, você pode acessar o n8n clicando no botão Gerenciar Aplicativo na mesma tela. Crie uma conta para finalizar a configuração.

2. Encontre uma API pública

O próximo passo é encontrar a API que você deseja integrar ao n8n. Você pode buscar por uma em marketplaces de APIs, como o RapidAPI, ou em catálogos comunitários como o repositório de APIs públicas do GitHub.

Para testes, recomendamos usar uma API pública, pois elas são gratuitas e fáceis de se inscrever. Neste tutorial, usaremos a API pública da Hostinger como exemplo.

A documentação da API é fundamental para garantir uma integração tranquila. O ideal é que a API tenha uma documentação completa, cobrindo especificações, requisitos e possíveis erros. Além disso, ela deve ser de uma empresa ou desenvolvedor confiável, para garantir a segurança na utilização.

3. Obtenha o endpoint e a chave da API

Depois de escolher a API, acesse o site do provedor e obtenha duas informações essenciais: o endpoint e a chave de autenticação.

O endpoint da API é a URL que o n8n usará para interagir com o servidor da API e fazer solicitações de dados específicos. Já a chave de autenticação é um token único que valida a solicitação da API feita pelo n8n.

A forma de obter o endpoint e a chave de autenticação varia conforme o provedor da API. Veja como fazer isso no caso da Hostinger:

1. Faça login no hPanel. Se você não tiver uma conta, crie uma.
2. No hPanel, clique no ícone do seu perfil no canto superior direito e selecione Informações da Conta.

3. No menu lateral, clique em API.
4. Clique no botão Documentação da API para acessar a página de referência da API da Hostinger, onde você pode verificar todos os endpoints e suas especificações.
5. Volte para a página da API e clique em Novo token para gerar uma chave de API.
6. Dê um nome ao seu token e defina uma data de expiração.

7. Clique em Gerar. 
8. Role até o final da página para obter o token da API e os comandos de teste. Guarde essas informações em um local seguro.

Por questões de segurança, você não conseguirá visualizar o token novamente após fechar a página da API, por isso é fundamental salvar a chave e os comandos de teste antes de prosseguir.

4. Faça sua primeira chamada de API

Testar o endpoint da API é fundamental para garantir que ele consiga receber solicitações e enviar respostas corretamente.

Existem diferentes maneiras de testar uma API, mas a forma mais simples é usar o comando cURL, que já vem pré-instalado no terminal do seu computador.

Para usar o cURL, basta abrir o terminal do seu sistema e digitar o seguinte comando, substituindo “API-endpoint” e “API-key” pelos valores reais:

curl -X GET "API-endpoint" \ -H "Authorization: Bearer API-key" 

Dependendo da API, pode ser necessário alterar o método de autenticação ou adicionar mais informações à solicitação cURL. Se o provedor da API fornecer comandos de teste, como faz a Hostinger, você pode simplesmente copiar e colar esses comandos no seu terminal. Caso contrário, consulte a documentação da API para mais informações.

Se a solicitação for bem-sucedida, o terminal exibirá os dados no formato JSON. Se ocorrer algum erro, verifique a documentação da API para consultar um guia de solução de problemas.

5. Configure sua API no n8n

Adicionar uma API no n8n é bem simples: basta adicionar o nó e preencher as informações necessárias. Veja como fazer:

1. Abra o n8n e crie um novo fluxo de trabalho.
2. Clique no ícone de Mais no canto superior direito da tela do n8n.
3. Selecione o nó HTTP Request.

4. Adicione as seguintes informações:
   • Método: O método HTTP que o n8n vai usar para interagir com o endpoint da API.
   • URL: O endereço do endpoint da sua API.
   • Autenticação: O método de autenticação para a chamada da API — geralmente Bearer, se você estiver usando uma chave.
   • Parâmetros de consulta: Restrições ou regras que podem modificar sua solicitação, às vezes obrigatórios.
   • Cabeçalhos e corpo: Informações adicionais a serem incluídas na solicitação para modificá-la, como cabeçalhos ou dados no corpo da requisição.

Se tiver dificuldades para preencher os campos, consulte a documentação da API e do n8n. Dependendo da especificação da sua API, pode ser que você não precise preencher todas as informações acima.

Embora sua API já esteja integrada ao n8n após essa etapa, ela ainda não estará funcional. Você precisará ativar o fluxo de trabalho para que a solicitação da API seja enviada e os dados sejam retornados.

Como criar fluxos de trabalho com endpoints de API?

Depois de integrar uma API à sua instância do n8n, o próximo passo é criar um fluxo de trabalho que utilize as capacidades da API para transformar e processar dados.

Para este tutorial, vamos criar um sistema simples de alertas, que notifica os usuários quando o uso de recursos do VPS ultrapassa determinados limites.

1. Escolha um método de gatilho

Para iniciar um fluxo de trabalho no n8n, é necessário um nó de gatilho. Existem várias opções, dependendo do tipo de automação que você deseja criar. Essas opções são classificadas em oito categorias:

• Gatilho manual: Inicia o fluxo de trabalho quando o usuário clica deliberadamente no nó de gatilho no canvas do n8n.
• Evento no aplicativo: Executa o fluxo de trabalho quando ocorre um evento em um aplicativo, como no Telegram, Notion ou Airtable.
• Agendado: Aciona o fluxo de trabalho em intervalos específicos, ideal para automatizar chamadas de API.
• Chamada de webhook: Inicia o fluxo quando o nó de gatilho recebe uma solicitação HTTP através da URL do webhook.
• Envio de formulário: Começa o fluxo de trabalho quando um formulário é enviado, passando os dados do formulário para o fluxo.
• Quando executado por outro fluxo: Ativa o fluxo de trabalho quando outro fluxo o chama.
• Mensagem de chat: Inicia o fluxo quando um usuário envia uma mensagem para o n8n.
• Outros: Começa o fluxo de trabalho quando um evento específico acontece, mas não está vinculado a um aplicativo específico, como um erro ou um novo e-mail.

Neste tutorial, usaremos o nó Webhook do n8n, que é um dos mais flexíveis e fáceis de configurar. Como ele utiliza uma URL, você pode iniciar o nó simplesmente abrindo o endereço no seu navegador. Além disso, você pode integrar o webhook em aplicativos personalizados, sem ficar restrito a plataformas específicas.

O nó de webhook funciona automaticamente, mas você pode configurar diversas opções para melhorar sua segurança e usabilidade. Por exemplo, é possível definir um método de autenticação para garantir que apenas usuários legítimos possam acioná-lo. Vamos falar mais sobre isso na próxima seção.

2. Crie um fluxo de trabalho

Criar um fluxo de trabalho no n8n envolve conectar nós para determinar o fluxo e o tratamento dos dados. No nosso caso, o plano do fluxo de trabalho é o seguinte:

1. Quando chamado, o nó Webhook dispara o fluxo de trabalho, enviando uma solicitação para a API no nó de solicitação HTTP.
2. A API busca os dados, que serão armazenados no nó de solicitação HTTP.
3. O nó de solicitação HTTP passa os dados para o nó Editar Campos para processamento.
4. O nó Editar Campos manipula os dados brutos. Neste caso, ele calcula a média de cada métrica de uso de recurso.
5. O nó If define uma lógica que dispara um evento específico com base nos dados processados. Se o uso de recursos ultrapassar um limite determinado, ele aciona o próximo nó. Caso contrário, não faz nada.
6. O nó Discord é ativado quando a média de uso de recursos ultrapassa o limite, enviando automaticamente uma notificação aos usuários.

O diagrama do fluxo de trabalho no canvas do n8n fica assim:

Você pode expandir ainda mais esse fluxo de trabalho conectando mais nós ou fluxos de trabalho – tudo depende da complexidade do seu objetivo de automação.

Por exemplo, é possível integrar um fluxo de trabalho que automaticamente solicita soluções de otimização de desempenho de ferramentas de IA combinando o MCP com o n8n. Outro exemplo é que você pode conectar o nó da planilha para registrar o histórico de picos de uso de hardware.

3. Configure a lógica do fluxo de trabalho

Configurar a lógica no n8n define como seu fluxo de trabalho selecionará, manipulará e usará os dados para obter os resultados desejados.

Por padrão, os dados brutos da API contêm informações que podem não ser relevantes ou compatíveis com a capacidade de processamento do nó subsequente. Reformatar e organizar esses dados garante que cada nó possa manipulá-los e encaminhá-los corretamente.

Lendo dados brutos da API

As APIs geralmente enviam respostas no formato JSON, que estrutura os dados em pares de chave-valor, como:

[
   {
      "cpu_usage": 
      {
         "unit": "%",
         "usage": {
            "1751494508": 1.5 }
      }
   }
]

Se analisarmos detalhadamente, cada ponto de dados é estruturado em um par de chave-valor chamado objeto, como:

{"key": value}

A chave deve ser uma string escrita entre aspas. Já o valor pode ser uma string, um número ou um objeto.

Além do formato JSON, o n8n fornece uma visualização de esquema e tabela dos dados da sua API, o que facilita a leitura e o processamento, pois você pode arrastá-los e soltá-los em outros nós.

Manipulando dados da API com JavaScript

O n8n permite que você passe dados para os nós usando dois métodos: Fixo ou Expressão. Fixo significa que o nó anterior encaminha um valor como está, enquanto Expressão permite que você manipule o valor antes de passá-lo.

Como a Expressão passa dados dinamicamente, ela é ideal quando se trabalha com grandes volumes de dados ou valores que mudam com frequência, como o histórico de uso de hardware.

As expressões no n8n são escritas dentro de um par de chaves duplas ({{ }}) e geralmente utilizam as bibliotecas Luxon e JMESPath. Veja um exemplo:

{{ $json.object }}

No nosso fluxo de trabalho, queremos definir um valor dinâmico que calcule a média dos dados de uso de recursos do VPS. Para isso, adicionamos o nó Editar Campos e usamos a seguinte expressão:

{{ $json.cpu_usage.usage.values().average() }}

Aqui está a explicação da expressão:

• $json: Pega o valor JSON, que é o dado bruto da API.
• cpu_usage.usage: Lê o objeto de uso dentro do campo cpu_usage, que contém uma lista de uso de recursos da CPU com carimbos de data/hora.
• values(): Retorna os valores do objeto anterior como um array, no caso, o valor de “1751494508”: 1.5 e assim por diante.
• average(): Calcula a média dos valores no array.

Se quisermos realizar a mesma operação para outras métricas de uso de hardware, basta ajustar o objeto conforme necessário. Por exemplo, aqui está uma expressão que calcula a média do uso de RAM:

{{ $json.ram_usage.usage.values().average() }}

4. Teste seu fluxo de trabalho

Testar seu fluxo de trabalho não apenas ajuda a verificar se sua automação está funcionando corretamente, mas também permite que você confira a saída de cada nó enquanto desenvolve a lógica. Como seus dados podem mudar ao passar por um nó e uma expressão, os testes ajudam a identificar quais dados precisam ser manipulados na próxima etapa.

Para testar seu fluxo de trabalho no n8n, basta clicar no botão Salvar e, em seguida, clicar em Executar Fluxo de Trabalho. Depois, inicie o fluxo de trabalho com base no nó de gatilho escolhido, que, neste caso, é a chamada do webhook.

Se o seu fluxo de trabalho rodar corretamente, você verá marcas de verificação nos nós e linhas verdes entre eles. Clique duas vezes em um nó para ver os valores de entrada e saída, o que ajudará a determinar como configurar o próximo nó.

5. Proteja seu fluxo de trabalho

Proteger seu fluxo de trabalho no n8n é essencial, especialmente quando ele contém dados privados ou informações sensíveis. Por exemplo, se partes não autorizadas descobrirem a URL do seu webhook, podem sobrecarregá-la com solicitações, o que pode causar falhas no seu sistema de automação.

A maneira mais importante de garantir a segurança do seu fluxo de trabalho é habilitar a autenticação no nó de gatilho. Isso garante que apenas fontes com credenciais válidas, como uma chave ou informações de login, possam iniciar o fluxo de trabalho.

Os passos para configurar a autenticação são semelhantes, independentemente do nó de gatilho. Veja como fazer isso no nó Webhook:

1. Clique duas vezes no nó Webhook para abrir a janela de configuração.
2. Clique no menu suspenso Autenticação e selecione um método. Vamos escolher Autenticação Básica.

3. Expanda o menu suspenso Credencial para autenticação básica e clique em Criar nova credencial. 
4. Digite um novo nome de usuário e senha. 

5. Clique em Salvar.

Agora, você só pode chamar o webhook com o nome de usuário e senha corretos. Para verificar se a autenticação está funcionando, abra a URL no seu navegador e uma janela pop-up pedindo as credenciais de login deve aparecer.

Se você usar outro nó e quiser habilitar a autenticação Bearer, precisará gerar um token que atenda aos requisitos de segurança do n8n usando uma ferramenta separada. Existem diferentes métodos e configurações para criar esse token. Por exemplo, veja como criar um token no formato Base64:

1. Abra uma ferramenta de programação online. Neste tutorial, usaremos o Base64Encode.
2. Insira um par de nome de usuário e senha no seguinte formato, que serão as credenciais de autenticação:

username:password

3. Clique em Encode.
4. Copie o token codificado e armazene-o em um local seguro.

Além de proteger o nó de gatilho, existem outras práticas essenciais de segurança para proteger seu fluxo de trabalho n8n-API. Vamos discutir mais sobre isso na próxima seção.

Quais são as melhores dicas para proteger e escalar uma API no n8n?

Proteger sua integração de API no n8n envolve diversas ações além da habilitação da autenticação. Além de manter a segurança, o desempenho da sua instância n8n auto-hospedada precisa se manter ótimo para garantir a capacidade de resposta e o funcionamento suave da sua automação.

Aqui estão algumas das melhores práticas para proteger e escalar seu fluxo de trabalho n8n com integração de API:

• Siga as práticas recomendadas de segurança do VPS. Proteja seu VPS implementando estratégias como configurar corretamente as regras do firewall e instalar um scanner de malware. Se seu servidor for comprometido, criminosos cibernéticos poderão acessar facilmente sua instância do n8n. 
• Limite o uso de URLs. Reserve a URL do webhook de produção para o ambiente de produção e evite expô-la no front-end. Manter essa URL segura evita que partes não autorizadas explorem ou controlem seu fluxo de trabalho.
• Atualize as chaves da API regularmente. Defina uma data de expiração curta para suas chaves de API. Quanto mais frequentemente você atualizar a chave de autenticação, menores as chances dela ser comprometida. 
• Valide entradas e saídas. Valide dados, especialmente os que vêm e são enviados para serviços externos como APIs, para garantir sua segurança. Às vezes, criminosos cibernéticos injetam códigos maliciosos nos dados durante a transferência, o que pode representar riscos sérios se não for detectado. 
• Use HTTPS. Sempre use HTTPS para trocar dados com APIs e outros serviços externos. Por padrão, a maioria das APIs já usa o protocolo criptografado, mas você também pode proxy a comunicação usando um gateway de API, como o NGINX.
• Implemente um sistema de monitoramento. Configure um sistema de monitoramento usando ferramentas como Prometheus e Grafana para rastrear o desempenho da sua instância do n8n, incluindo CPU, memória e tempos de execução dos fluxos de trabalho. Isso ajuda a identificar gargalos, áreas para melhorar o desempenho e possíveis ataques cibernéticos, como DDoS.
• Considere o limite de taxa da API. APIs públicas geralmente limitam o número de requisições dentro de um período específico para evitar sobrecarga, downtime e mau uso. Defina atrasos apropriados entre as requisições no seu fluxo de trabalho n8n para evitar ultrapassar o limite, o que pode resultar em interrupções nos serviços ou bloqueio de acesso.
• Ative o modo de fila do n8n. Faça isso para descarregar tarefas para vários trabalhadores, permitindo o processamento assíncrono e distribuído. Isso permite que seus fluxos de trabalho lidem com grandes volumes de tarefas sem bloqueios e melhora o desempenho ao processar tarefas em segundo plano.

Como criar um fluxo de trabalho com OneSimpleAPI

Criar um fluxo de trabalho com o OneSimpleAPI facilita a integração de APIs com funcionalidades variadas, como gerar códigos QR ou tirar capturas de tela, no seu sistema de automação. Com o nó OneSimpleAPI pré-configurado do n8n, você pode conectar rapidamente diferentes recursos de API sem precisar configurar seus endpoints individualmente.

Para usar o OneSimpleAPI, você precisa criar uma conta e um token. Veja como fazer isso:

1. Abra a página de registro de usuário do OneSimpleAPI e crie uma conta.
2. Abra a caixa de entrada do e-mail que você usou para o registro.
3. Verifique se há um e-mail do OneSimpleAPI e siga as instruções para validar sua conta.
4. Você será redirecionado para a página de criação do token da API. Nesse menu, insira um nome e selecione as permissões para o seu token.

5. Clique em Criar.
6. Uma janela pop-up será exibida. Copie o token da API e armazene-o em um local seguro. 

Em seguida, vamos adicionar o nó OneSimpleAPI ao seu fluxo de trabalho:

1. Clique no ícone de mais na tela do n8n e selecione OneSimpleAPI.
2. Escolha a ação que o OneSimpleAPI irá realizar. Por exemplo, vamos escolher Obter detalhes de um artista do Spotify, mas lembre-se de que os passos de configuração podem variar dependendo da ação escolhida.
3. Expanda o menu suspenso Credencial para conectar e escolha Criar nova credencial.

4. Insira o token da API que você criou anteriormente. Clique em Salvar.

Pronto! Agora, teste seu fluxo de trabalho para garantir que o nó OneSimpleAPI consiga receber e processar os dados corretamente.

Alternativas e usos comuns de APIs

Integrar uma API no n8n permite criar fluxos de trabalho automatizados para diversas situações. Aqui estão alguns dos casos mais comuns:

• Conectar aplicativos proprietários ou de nicho. Ao trabalhar com ferramentas internas ou serviços personalizados, o nó HTTP Request permite fazer chamadas API para esses serviços. Por exemplo, você pode integrar seu sistema CRM interno para buscar ou atualizar dados de clientes.
• Implementar operações de API personalizadas. Algumas APIs oferecem funcionalidades que não estão disponíveis nos nós nativos do n8n. Por exemplo, consultas complexas em um banco de dados podem não ser possíveis utilizando apenas os nós e a biblioteca de expressões padrão do n8n. Nesse caso, será necessário usar a API diretamente para realizar essas operações.
• Integrar múltiplos endpoints de API. Você pode criar um fluxo de trabalho com vários endpoints de API que podem ser acionados a partir de uma única URL, facilitando a integração de múltiplos provedores de serviço. Por exemplo, é possível conectar as APIs da Hostinger e do Jira para criar um sistema que automaticamente gere um ticket no Jira quando seu VPS tiver algum tempo de inatividade.
• Manipular transformações complexas de dados. Como as APIs geralmente retornam estruturas de dados aninhadas ou complexas, os nós de transformação de dados do n8n ajudam a processar e formatar esses dados conforme necessário. As ferramentas e bibliotecas pré-configuradas do n8n tornam esse processo mais eficiente.
• Criar microsserviços com n8n. Combinando múltiplos webhooks e fluxos de trabalho, você pode criar microsserviços dentro do n8n, permitindo soluções de automação modulares e escaláveis. Por exemplo, é possível integrar a API do WooCommerce para gerenciar o inventário da sua loja online, a API do Stripe para os pagamentos e a API do Shippo para o mecanismo de envio. 

Principais conclusões: usando uma API com o n8n

Integrar uma API ao seu fluxo de trabalho no n8n permite automatizar uma ampla gama de tarefas que envolvem a troca de dados com diversos serviços, incluindo ferramentas ou softwares proprietários.

Com a funcionalidade baseada em API, você pode utilizar recursos complexos ou capacidades de processamento de dados além do que o n8n oferece nativamente. Também é possível combinar múltiplas APIs em um fluxo de trabalho, permitindo que outros serviços as usem por meio de um único endpoint.

Além das APIs públicas de provedores externos, você também pode integrar facilmente diversas funcionalidades de API com o nó OneSimpleAPI do n8n.

Dadas as vastas capacidades das APIs e os nós do n8n, combinar essas ferramentas torna possível automatizar várias tarefas. Recomendamos conferir nossos exemplos de fluxo de trabalho do n8n para aprender mais sobre o que você pode automatizar com essa ferramenta.