negocie

n8n node to create a new negotiation in Negocie API

Package Information

Released: 9/18/2025
Downloads: 1 weekly / 157 monthly
Latest Version: 0.0.1
Author: bellinatiperez

Documentation

n8n-nodes-negocie

Node customizado para n8n que permite integração com a API Negocie para gerenciamento de negociação de dívidas.

Descrição

Este pacote fornece um node personalizado para n8n que permite:

  • Autenticação de devedores
  • Busca de dívidas
  • Consulta de opções de pagamento
  • Negociação de dívidas
  • Emissão de segunda via de boletos
  • Consulta de acordos formalizados

Instalação

Via npm (Recomendado)

npm install @bellinatiperez/n8n-nodes-negocie

Via n8n Community Nodes

  1. Acesse as configurações do n8n
  2. Vá para "Community Nodes"
  3. Instale o pacote: @bellinatiperez/n8n-nodes-negocie

Via Docker

Se você estiver usando n8n via Docker, adicione o pacote ao seu Dockerfile:

FROM n8nio/n8n:latest
RUN npm install --prefix /home/node/.n8n/nodes @bellinatiperez/n8n-nodes-negocie

Configuração

Credenciais OAuth2

O node utiliza autenticação OAuth2. Configure as credenciais:

  1. Authorization URL: https://api.devbpbr.services/auth/dialog
  2. Access Token URL: https://api.devbpbr.services/auth/token
  3. Client ID: Fornecido pela Negocie
  4. Client Secret: Fornecido pela Negocie

Uso Básico

Recursos Disponíveis

1. Autenticação

  • Autenticar devedor: Autentica um devedor usando CPF/CNPJ

2. Dívida

  • Buscar dívidas: Lista dívidas de um devedor
  • Buscar opções de pagamento: Consulta opções de pagamento para uma dívida
  • Negociar dívida: Negocia uma dívida com base na opção selecionada

3. Pagamento

  • Emitir segunda via de boleto: Gera segunda via de boleto

4. Acordo

  • Buscar acordos: Lista acordos formalizados de um devedor

Exemplos de Implementação

Exemplo 1: Buscar Dívidas de um Devedor

{
  "resource": "divida",
  "operation": "buscar_dividas",
  "documento": "12345678901",
  "token": "seu_bearer_token",
  "financeira": "nome_da_financeira"
}

Exemplo 2: Autenticar Devedor

{
  "resource": "autenticacao",
  "operation": "autenticar_devedor",
  "clientId": "seu_client_id",
  "clientSecret": "seu_client_secret",
  "documento": "12345678901"
}

Exemplo 3: Buscar Acordos

{
  "resource": "acordo",
  "operation": "buscar_acordos",
  "documento": "12345678901",
  "token": "seu_bearer_token"
}

Desenvolvimento

Pré-requisitos

  • Node.js >= 16
  • npm >= 8
  • TypeScript

Configuração do Ambiente de Desenvolvimento

# Clone o repositório
git clone https://github.com/bellinatiperez/n8n-nodes-negocie.git
cd n8n-nodes-negocie

# Instale as dependências
npm install

# Compile o projeto
npm run build

# Execute em modo de desenvolvimento
npm run dev

Scripts Disponíveis

  • npm run build: Compila o TypeScript e constrói os ícones
  • npm run dev: Executa o TypeScript em modo watch
  • npm run format: Formata o código usando Prettier
  • npm run lint: Executa o ESLint
  • npm run lintfix: Corrige automaticamente problemas do ESLint

Publicação no npmjs

Pré-requisitos para Publicação

  1. Conta no npmjs: Crie uma conta em npmjs.com
  2. Autenticação: Faça login via CLI
    npm login
    
  3. Permissões: Certifique-se de ter permissões para publicar no escopo @bellinatiperez

Preparação do Pacote

1. Verificar Configurações do package.json

Certifique-se de que as seguintes configurações estão corretas:

{
  "name": "@bellinatiperez/n8n-nodes-negocie",
  "version": "0.0.1",
  "description": "n8n node to create a new negotiation in Negocie API",
  "keywords": ["n8n-community-node-package"],
  "license": "MIT",
  "main": "index.js",
  "files": ["dist"],
  "n8n": {
    "n8nNodesApiVersion": 1,
    "credentials": ["dist/credentials/NegocieOAuth2Api.credentials.js"],
    "nodes": ["dist/nodes/Negocie/Negocie.node.js"]
  }
}

2. Validar Estrutura do Projeto

# Verificar se todos os arquivos necessários estão presentes
ls -la dist/
# Deve conter:
# - credentials/
# - nodes/
# - package.json

Versionamento

Estratégia de Versionamento (Semantic Versioning)

  • MAJOR (X.0.0): Mudanças incompatíveis na API
  • MINOR (0.X.0): Novas funcionalidades compatíveis
  • PATCH (0.0.X): Correções de bugs compatíveis

Comandos de Versionamento

# Incrementar versão patch (0.0.1 -> 0.0.2)
npm version patch

# Incrementar versão minor (0.0.1 -> 0.1.0)
npm version minor

# Incrementar versão major (0.0.1 -> 1.0.0)
npm version major

# Definir versão específica
npm version 1.2.3

Processo de Publicação

1. Preparação e Validação

# Limpar e reinstalar dependências
rm -rf node_modules package-lock.json
npm install

# Executar testes de qualidade
npm run lint
npm run format

# Compilar o projeto
npm run build

2. Validação Pré-publicação

# Executar script de pré-publicação (inclui build e lint)
npm run prepublishOnly

# Verificar conteúdo do pacote
npm pack --dry-run

# Testar instalação local
npm pack
npm install -g bellinatiperez-n8n-nodes-negocie-*.tgz

3. Publicação

# Publicar versão beta (opcional)
npm publish --tag beta

# Publicar versão estável
npm publish

# Publicar versão com acesso público (se necessário)
npm publish --access public

4. Publicação com Tags

# Publicar com tag específica
npm publish --tag next

# Promover tag para latest
npm dist-tag add @bellinatiperez/n8n-nodes-negocie@1.0.0 latest

Verificação Após Publicação

1. Verificar no Registry

# Verificar informações do pacote
npm view @bellinatiperez/n8n-nodes-negocie

# Verificar versões disponíveis
npm view @bellinatiperez/n8n-nodes-negocie versions --json

# Verificar dependências
npm view @bellinatiperez/n8n-nodes-negocie dependencies

2. Testar Instalação

# Criar projeto de teste
mkdir test-installation
cd test-installation
npm init -y

# Instalar o pacote publicado
npm install @bellinatiperez/n8n-nodes-negocie

# Verificar se foi instalado corretamente
ls node_modules/@bellinatiperez/n8n-nodes-negocie/

3. Verificar no Site do npm

Acesse: https://www.npmjs.com/package/@bellinatiperez/n8n-nodes-negocie

Verifique:

  • ✅ Descrição está correta
  • ✅ Keywords estão presentes
  • ✅ README é exibido corretamente
  • ✅ Versão publicada está correta
  • ✅ Arquivos estão listados

Troubleshooting

Problemas Comuns

  1. Erro de Permissão

    npm ERR! 403 Forbidden
    

    Solução: Verificar login e permissões do escopo

    npm whoami
    npm login
    
  2. Versão já Existe

    npm ERR! 409 Conflict
    

    Solução: Incrementar versão

    npm version patch
    npm publish
    
  3. Arquivos Ausentes

    npm ERR! Missing required files
    

    Solução: Verificar campo files no package.json e executar build

    npm run build
    npm publish
    

Estrutura do Projeto

n8n-nodes-negocie/
├── credentials/
│   └── NegocieOAuth2Api.credentials.ts
├── nodes/
│   └── Negocie/
│       ├── Common.ts
│       ├── GenericFunctions.ts
│       ├── Negocie.node.json
│       ├── Negocie.node.ts
│       └── negocie-img.svg
├── dist/                    # Arquivos compilados
├── docker/
│   └── Dockerfile
├── .eslintrc.js
├── .gitignore
├── .npmignore
├── .prettierrc.js
├── gulpfile.js
├── package.json
├── tsconfig.json
└── README.md

Contribuição

  1. Fork o projeto
  2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
  3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
  4. Push para a branch (git push origin feature/AmazingFeature)
  5. Abra um Pull Request

Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE.md para detalhes.

Suporte

Changelog

[0.0.1] - 2024-01-XX

  • Versão inicial
  • Implementação básica dos recursos de autenticação, dívidas, pagamentos e acordos
  • Suporte a OAuth2
  • Integração com API Negocie

Discussion