Pular para o conteúdo principal

N8N

Nó personalizado Efí para N8N


O n8n é uma plataforma de automação de fluxos de trabalho que permite conectar diversas APIs e serviços de forma visual e flexível. Ele possibilita a criação de integrações personalizadas sem a necessidade de programação avançada, utilizando um sistema de nós (nodes) para conectar diferentes sistemas.

O n8n-nodes-efibank é um nó personalizado para o n8n que simplifica a integração com a API Cobranças e a API Pix do Efibank, permitindo a automação de fluxos financeiros, como pagamentos, recebimentos e transações.


1. Requisitos​

1.1. Versão do Node.js​

Este nó personalizado requer uma versão do Node.js compatível com o n8n. A versão mínima necessária é 18.17, e a versão máxima suportada é 22.


2. Instalação​

Para instalar o nó em uma instalação existente do n8n, utilize uma das opções abaixo:

2.1. Instalação via Community Nodes (interface gráfica do n8n)​

Para instalar o nó n8n-nodes-efibank diretamente pela interface gráfica do n8n, utilizando a funcionalidade Community Nodes, siga as etapas:

  • Acesse o painel do n8n no navegador (geralmente em http://localhost:5678).
  • No canto inferior esquerdo, clique nos três pontinhos ao lado da sua foto de perfil.
  • Selecione a opção Settings.
  • Selecione a aba Community Nodes.
  • Clique no botão Install a community node.
  • No campo de instalação, digite n8n-nodes-efibank.
  • Clique em Install e aguarde a conclusão.

Após a instalação, será necessário reiniciar o n8n para que o novo nó esteja disponível:

  • Se estiver usando Docker: execute docker restart n8n.
  • Se estiver rodando localmente: reinicie o processo com n8n stop e n8n start.

Depois disso, o nó Efí Bank Cobranças e Efí Bank Pix estarão disponíveis na sua lista de nós para uso nos workflows.

2.2. Instalação via NPM​

$ npm install n8n-nodes-efibank

2.3. Instalação via GIT​

$ git clone https://github.com/efipay/n8n-nodes-efibank.git

3. Instalação do nó (somente para instalação via NPM ou Git)​

Para instalar corretamente o nó personalizado, siga estas etapas:

  • Instale as dependências:
    • npm install
  • Compile o código:
    • npm run build
  • Configure o link para uso local (desenvolvimento):
    • npm link
  • Inicie o n8n:
    • n8n

4. Configuração do nó​

Antes de iniciar a configuração, você precisará obter suas credenciais de Produção e Homologação na conta Efí. Siga os passos abaixo:

  • Acesse o painel da Efí no menu API.
  • No menu lateral, clique em Aplicações e selecione Criar aplicação.
  • Informe um nome para a aplicação (exemplo: n8n).
  • Selecione a opção "API Cobranças" e ative o escopo "Emissão de cobranças".
  • Caso utilize a "API Pix", ative todos os escopos de Produção e Homologação.
  • Clique em Continuar.
  • Informe a sua Assinatura Eletrônica para confirmar as alterações e atualizar a aplicação.

Após concluir esse processo, suas credenciais client_id e client_secret, serão exibidas a uma tela semelhante a tela abaixo:


Configuração do Nó da API Cobranças​

No ambiente do n8n, acesse seu workflow e busque pelo nó Efí Bank Cobranças. Para configurar as credenciais, siga os passos abaixo:

  • Clique em Create New Credential, conforme a iamgem abaixo, para adicionar uma nova credencial.
  • Selecione o ambiente (Homologação/Produção).
  • Insira as credenciais Client ID e Client Secret para os dois ambientes.
  • Clique em Save.

Configuração do Nó da API Pix​

No ambiente do n8n, acesse seu workflow e busque pelo nó Efí Bank Pix. Para configurar as credenciais, siga os passos abaixo:

  • Clique em Create New Credential, conforme a iamgem abaixo, para adicionar uma nova credencial.
  • Selecione o ambiente (Homologação/Produção).
  • Insira as credenciais Client ID e Client Secret para os dois ambientes.
  • Configure o certificado:
    • Gere um certificado em sua conta Efí, seguindo este guia.
    • Converta o certificado .p12 fazendo o upload na página de conversão e clique em "Codificar e Exibir" para obter os dados necessários.
    • Copie o conteúdo do Certificado e cole no campo Certificado.
    • Copie o conteúdo da Key e cole no campo Key.
  • Clique em Save.

5. Teste​

Para testar a integração, siga estes passos:

  • Selecione o tipo da transação desejada.
  • Escolha o endpoint correspondente.
  • Preencha os dados necessários para a requisição. Utilize os exemplos pré-preenchidos ou informe os dados específicos da sua integração.
  • Clique em Test step para executar o teste.

6. Dúvida Frequente​

Onde posso acompanhar as transações geradas pelo n8n?​

As transações geradas através do plugin podem ser acompanhadas em sua conta Efí no menu API > Minhas Aplicações > Sua Aplicação. Neste ambiente você poderá acompanhar todas as transações e suas respectivas situações.


7. Suporte e Sugestões​

Suas sugestões de novas ideias e implementações para o nó personalizado da Efí são muito importantes. Portanto, caso você tenha alguma ideia, entre em contato com a nossa equipe. Iremos analisar sua sugestão e avaliar a possibilidade de implantação.

Caso você tenha alguma dúvida, entre em contato conosco pelo site Efí.

Última atualização em