abacatepay

n8n node for AbacatePay integration

Package Information

Downloads: 30 weekly / 45 monthly
Latest Version: 1.0.8
Author: Antonio Duarte

Documentation

n8n-nodes-abacatepay

Este é um nó customizado do n8n para integração com a API do AbacatePay.

Funcionalidades

  • Clientes: Criar e listar clientes
  • Cupons: Criar e listar cupons de desconto
  • Cobrança: Criar e listar cobranças
  • PIX: Criar QR codes PIX, verificar status e simular pagamentos

Instalação

Opção 1: Instalar via npm (quando publicado)

npm install n8n-nodes-abacatepay

Opção 2: Instalação Manual para Desenvolvimento

  1. Clone este repositório:

    git clone <repository-url>
    cd n8n-abacatepay
    
  2. Instale as dependências e compile:

    npm install
    npm run build
    
  3. Vincule à sua instalação do n8n:

    # Se você tem o n8n instalado globalmente
    npm link
    cd ~/.n8n/custom
    npm link n8n-nodes-abacatepay
    
    # Ou copie a pasta dist para o diretório de nós customizados do n8n
    cp -r dist/* ~/.n8n/custom/
    
  4. Reinicie o n8n:

    n8n start
    

Configuração

  1. No n8n, vá para Credentials e crie uma nova credencial do tipo AbacatePay API
  2. Insira seu token de API do AbacatePay
  3. Selecione o ambiente (Production ou Sandbox)

Uso

  1. Adicione o nó AbacatePay ao seu workflow
  2. Selecione o recurso desejado (Customer, Coupon, Billing, PIX)
  3. Escolha a operação (Create, List, Check Status, etc.)
  4. Configure os parâmetros necessários
  5. Execute o workflow

Recursos Disponíveis

Customer (Cliente)

  • Create: Criar um novo cliente
  • List: Listar clientes existentes

Coupon (Cupom)

  • Create: Criar um novo cupom de desconto
  • List: Listar cupons existentes

Billing (Cobrança)

  • Create: Criar uma nova cobrança
  • List: Listar cobranças existentes

PIX

  • Create QR Code: Criar um QR code PIX
  • Check Status: Verificar status de um pagamento
  • Simulate Payment: Simular um pagamento (apenas sandbox)

Documentação da API

Para mais informações sobre os parâmetros e respostas da API, consulte a documentação oficial do AbacatePay.

Desenvolvimento

Comandos Disponíveis

# Instalar dependências
npm install

# Compilar o projeto
npm run build

# Modo de desenvolvimento (observa mudanças)
npm run dev

# Verificar formatação
npm run format

# Executar linting
npm run lint

Estrutura do Projeto

n8n-abacatepay/
├── credentials/
│   └── AbacatePayApi.credentials.ts
├── nodes/
│   └── AbacatePay/
│       ├── AbacatePay.node.ts
│       ├── GenericFunctions.ts
│       └── abacatepay.svg
├── dist/                    # Arquivos compilados
├── package.json
├── tsconfig.json
└── README.md

Contribuição

Contribuições são bem-vindas! Por favor, abra uma issue ou envie um pull request.

Licença

MIT

Discussion