n8n-nodes-resgata

Integração completa com a API Resgata para n8n - Gestão de crédito consignado, clientes, atendimentos e propostas.

📋 Índice

• Instalação
• Configuração
• Recursos
• Uso
• API Coverage
• Desenvolvimento
• Suporte

🚀 Instalação

Instalação via npm (Recomendado)

npm install @corlabs-holding/n8n-nodes-resgata

Instalação Manual

1. Navegue até o diretório de instalação do n8n
2. Execute: npm install @corlabs-holding/n8n-nodes-resgata
3. Reinicie o n8n

⚙️ Configuração

Método 1: Token Bearer (Recomendado)

Use um token de acesso direto da API Resgata.

1. Acesse o dashboard da Resgata
2. Gere um token de API
3. No n8n, adicione credenciais "Resgata API"
4. Selecione "Token Direto (Bearer)"
5. Cole seu token

Configuração:

• URL de Autenticação: https://api.resgata.com
• URL da API: https://api.resgata.ai
• Bearer Token: Seu token de API

Método 2: Email e Senha

Faça login automaticamente com suas credenciais.

1. No n8n, adicione credenciais "Resgata API"
2. Selecione "Login (Email + Senha)"
3. Insira seu email e senha
4. Escolha o tipo de token:
   • API Access Token (Longa Duração) - Recomendado para integrações
   • Access Token (Curta Duração) - Expira em 1 hora

Configuração:

• URL de Autenticação: https://api.resgata.com
• URL da API: https://api.resgata.ai
• Email: [email protected]
• Senha: sua-senha
• Tipo de Token: api_access_token

🎯 Recursos

Clientes

Gerenciamento completo de clientes e vínculos empregatícios.

• ✅ Criar cliente
• ✅ Criar cliente com atendimento
• ✅ Atualizar cliente
• ✅ Buscar clientes (CPF ou telefone)
• ✅ Listar clientes (com paginação)
• ✅ Deletar cliente
• ✅ Obter vínculos empregatícios
• ✅ Adicionar vínculo empregatício
• ✅ Atualizar vínculo empregatício
• ✅ Obter histórico do cliente

Atendimentos

Gestão de atendimentos ao cliente.

• ✅ Criar atendimento
• ✅ Buscar atendimento
• ✅ Obter atendimento por protocolo
• ✅ Listar atendimentos (com paginação)
• ✅ Atualizar atendimento
• ✅ Atribuir atendimento a usuário
• ✅ Encerrar atendimento

Propostas

Operações de crédito CLT e FGTS.

• ✅ Listar propostas (com paginação)
• ✅ Buscar por CPF
• ✅ Autorização CLT
• ✅ Relacionamento CLT
• ✅ Detalhes CLT
• ✅ Simulação CLT
• ✅ Contratação CLT
• ✅ Simulação FGTS
• ✅ Contratação FGTS

Leads

Gerenciamento de leads e conversões.

• ✅ Criar lead
• ✅ Listar leads (com paginação)
• ✅ Obter lead por CPF
• ✅ Atualizar lead
• ✅ Deletar lead

Integrações

Webhooks e integrações externas.

• ✅ Webhook Chatwoot
• ✅ Webhook Bankerize

💡 Uso

Exemplo 1: Criar Cliente

{
  "resource": "customers",
  "operation": "create",
  "cpf": "123.456.789-09",
  "phone": "(11) 98765-4321"
}

Exemplo 2: Buscar Atendimentos

{
  "resource": "attendances",
  "operation": "list",
  "page": 1,
  "limit": 20,
  "filters": {
    "status": "open"
  }
}

Exemplo 3: Simulação de Proposta CLT

{
  "resource": "proposals",
  "operation": "employmentSimulation",
  "protocolNumber": "ATD-2024-001",
  "bank": "bmp",
  "options": {
    "timeout": 300
  }
}

Exemplo 4: Criar Lead

{
  "resource": "leads",
  "operation": "create",
  "cpf": "123.456.789-09",
  "name": "João Silva",
  "requestId": "req-12345",
  "additionalData": {
    "source": "website",
    "campaign": "summer2024"
  }
}

📊 API Coverage

| Recurso | Operações | Cobertura | |---------|-----------|-----------| | Clientes | 10 | ✅ 100% | | Atendimentos | 7 | ✅ 100% | | Propostas | 9 | ✅ 100% | | Leads | 5 | ✅ 100% | | Integrações | 2 | ✅ 100% | | Total | 33 | ✅ 100% |

🤖 Compatibilidade com AI Agents

Este node é totalmente compatível com AI Agents do n8n! Use-o como ferramenta em workflows de automação inteligente.

{
  "usableAsTool": true
}

🔧 Desenvolvimento

Pré-requisitos

• Node.js >= 18.0.0
• npm ou yarn

Instalação Local

# Clone o repositório
git clone https://github.com/resgataai/n8n_node_resgata.git

# Instale as dependências
cd n8n_node_resgata
npm install

# Build
npm run build

Scripts Disponíveis

# Build do projeto
npm run build

# Modo desenvolvimento (watch)
npm run dev

# Executar testes
npm test

# Executar testes em modo watch
npm run test:watch

# Coverage de testes
npm run test:coverage

# Lint
npm run lint

# Lint com correção automática
npm run lint:fix

# Formatação
npm run format

# Verificar formatação
npm run format:check

Executar Testes

# Todos os testes
npm test

# Com coverage
npm run test:coverage

# Watch mode para desenvolvimento
npm run test:watch

Estrutura do Projeto

n8n_node_resgata/
├── .github/
│   └── workflows/          # GitHub Actions CI/CD
├── __tests__/              # Testes unitários
├── credentials/            # Definições de credenciais
├── nodes/
│   └── Resgata/
│       ├── descriptions/   # Descrições de recursos
│       ├── Resgata.node.ts # Node principal
│       ├── ResgataHelpers.ts # Funções auxiliares
│       └── icon.svg        # Ícone do node
├── dist/                   # Build output
└── docs/                   # Documentação da API

🐛 Troubleshooting

Erro: "Bearer Token não configurado"

Causa: Token não foi fornecido nas credenciais.

Solução: Verifique se você inseriu o token Bearer nas credenciais do n8n.

Erro: "Login falhou: Email ou senha inválidos"

Causa: Credenciais de login incorretas.

Solução:

1. Verifique se o email e senha estão corretos
2. Confirme que sua conta tem acesso à API
3. Tente fazer login manualmente no dashboard da Resgata

Erro: "Timeout na operação"

Causa: Operações de proposta podem demorar aguardando webhooks.

Solução: Aumente o timeout nas opções da operação:

{
  "options": {
    "timeout": 600  // 10 minutos
  }
}

Erro: "CPF inválido"

Causa: CPF fornecido não passa na validação de checksum.

Solução:

1. Verifique se o CPF está correto
2. O node aceita CPF com ou sem formatação: 123.456.789-09 ou 12345678909

Erro: "JSON inválido no webhook payload"

Causa: O payload JSON do webhook está malformado.

Solução:

1. Valide seu JSON em um validador online
2. Certifique-se de que todas as aspas estão corretas
3. Verifique se não há vírgulas extras

🤝 Contribuindo

Contribuições são bem-vindas! Por favor:

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

Convenções de Commit

Seguimos Conventional Commits:

• feat: Nova funcionalidade
• fix: Correção de bug
• docs: Apenas documentação
• style: Formatação, sem mudança de código
• refactor: Refatoração sem mudança de comportamento
• test: Adição ou correção de testes
• chore: Manutenção geral

📄 Licença

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

🔗 Links

• Documentação da API Resgata
• n8n Documentation
• Reportar Bug
• Solicitar Feature

👥 Autores

• Anthony Max - [email protected]

🙏 Agradecimentos

• Equipe Resgata
• Comunidade n8n
• Todos os contribuidores

Desenvolvido com ❤️ pela equipe Resgata