Instalação

📘

ATENÇÃO

Recomendamos sempre testar em ambiente de desenvolvimento antes de instalar em produção.

Antes de instalar ou atualizar o Community Node:

  • faça backup dos seus workflows;
  • valide a instalação utilizando o ambiente Sandbox;
  • confirme a compatibilidade da versão do n8n e do Node.js utilizadas.

Esses cuidados reduzem o risco de interrupções em automações já existentes durante atualizações.


O que é o nó Asaas para n8n?

O nó oficial do Asaas para n8n permite integrar workflows diretamente com a API do Asaas, dispensando a criação manual de requisições HTTP para as operações mais comuns.

Com ele, é possível automatizar processos financeiros, sincronizar informações entre sistemas e criar fluxos envolvendo clientes, cobranças, assinaturas, Pix, Webhooks e diversos outros recursos disponíveis na API do Asaas.

Quando utilizar

Este nó é recomendado quando sua automação precisar:

  • criar e gerenciar clientes;
  • emitir cobranças por Pix, boleto ou cartão;
  • criar e administrar assinaturas;
  • trabalhar com parcelamentos;
  • consultar dados financeiros e comerciais;
  • receber eventos via Webhook para automatizar processos;
  • integrar o Asaas com ERPs, CRMs, e-commerces ou outras aplicações suportadas pelo n8n.

Caso sua integração utilize funcionalidades ainda não disponíveis no nó oficial, também é possível utilizar o nó HTTP Request juntamente com a API do Asaas.


Recursos

O nó disponibiliza operações organizadas por recurso da API do Asaas.

Atualmente estão disponíveis:

  • Clientes — criação, consulta, atualização e gerenciamento de clientes;
  • Cobranças — emissão, consulta e gerenciamento de cobranças;
  • Assinaturas — criação e administração de recorrências;
  • Parcelamentos — criação e acompanhamento de cobranças parceladas;
  • Dados comerciais — consulta de informações comerciais da conta;
  • Dados financeiros — consulta de informações financeiras;
  • Notificações — gerenciamento de notificações;
  • Pix (Cash-in) — consulta de recebimentos Pix;
  • Webhooks — configuração de eventos para automações.

Versões Compatíveis

  • n8n >= 1.0.0
  • Node.js >= 20.15.0

Pré-requisitos

Antes de instalar o nó, verifique se você possui:

  • Node.js na versão 20.15.0 ou superior;
  • uma conta ativa no Asaas (Sandbox ou Produção);
  • uma API Key válida obtida no painel do Asaas.

Através do Community Nodes (Recomendado)

O nó pode ser instalado gratuitamente através do sistema de Community Nodes do n8n.

  1. Acesse o n8n.

  2. Vá em Settings → Community Nodes.

  3. Clique em Install a community node.

  4. Informe o pacote:

@asaasbr/n8n-nodes-asaas
  1. Clique em Install.

  2. Reinicie o n8n.


Configuração das Credenciais

Após instalar o Community Node:

  1. No n8n, acesse Credentials → Add Credential.

  2. Procure por Asaas API.

  3. Preencha as informações da credencial.

Parâmetros importantes

Durante a configuração serão solicitados:

  • API Key — chave utilizada para autenticar todas as requisições realizadas ao Asaas;
  • Environment — define se a integração utilizará o ambiente Sandbox ou Produção.

Utilize sempre a API Key correspondente ao ambiente selecionado.


Verificação da Instalação (Exemplo)

Após configurar as credenciais, recomenda-se validar se o nó foi instalado corretamente.

  1. Crie um novo workflow.

  2. Arraste o nó Asaas para o canvas.

  3. Selecione o recurso Clientes.

  4. Escolha a operação Listar Clientes.

  5. Selecione a credencial criada anteriormente.

  6. Execute o workflow.

Se a operação retornar a lista de clientes sem erros de autenticação, a instalação foi concluída corretamente.


Exemplo de uso

Um fluxo simples pode ser composto por:

Webhook
↓
Asaas
(Recurso: Clientes)
↓
Listar Clientes
↓
IF
↓
Continuar automação

Da mesma forma, o nó pode ser utilizado para automatizar a emissão de cobranças, criação de assinaturas, consulta de informações financeiras e processamento de eventos recebidos via Webhook.


Comportamentos importantes

Antes de utilizar o nó, considere que:

  • todas as operações utilizam as permissões da API Key configurada;
  • as chamadas seguem o comportamento da API do Asaas;
  • operações de Webhook dependem da configuração correta dos eventos na conta Asaas;
  • erros retornados pela API também serão retornados pelo nó, permitindo que sejam tratados pelos recursos nativos do n8n.

Erros comuns

ProblemaPossível causa
Credencial inválidaAPI Key incorreta, revogada ou pertencente a outro ambiente
Erro de autenticaçãoPermissões insuficientes para a operação realizada
O nó não aparece após a instalaçãoO Community Node não foi instalado corretamente ou o n8n não foi reiniciado
Não é possível conectar ao AsaasAmbiente configurado incorretamente (Sandbox ou Produção)

Instalação em projetos locais

Caso prefira instalar o pacote manualmente em uma instalação própria do n8n:

  1. Valide as versões do projeto.

  2. Execute o comando:

npm install @asaasbr/n8n-nodes-asaas

Conteúdos relacionados

Após concluir a instalação, consulte também:

  • Guia da API do Asaas;
  • Autenticação via API Key;
  • Webhooks;
  • Cobranças;
  • Assinaturas;
  • Pix;
  • Limites da API (Rate Limits).