n8n-nodes-william-crm
v1.0.0
Published
n8n community node for William CRM integration - Complete automation for leads, clients, projects, invoices and support tickets
Maintainers
Readme
🚀 n8n-nodes-william-crm
Um node personalizado do n8n para integração completa com o William CRM.

🎯 Funcionalidades
📋 Operações Disponíveis:
- Leads - Criar, listar, atualizar, excluir
- Clientes - Gerenciar clientes completos
- Projetos - Acompanhar desenvolvimento
- Propostas - Criar e gerenciar propostas
- Faturas - Controle financeiro
- Tickets - Sistema de suporte
⚡ Recursos Avançados:
- ✅ Autenticação automática via API Key
- ✅ Validation completa de dados
- ✅ TypeScript com tipagem total
- ✅ Error handling robusto
- ✅ Documentação integrada no n8n
- ✅ Suporte a webhook triggers
🚀 Instalação
Via n8n Community Nodes (Recomendado)
- Abra o n8n (versão 0.187.0+)
- Vá em Settings > Community Nodes
- Clique em "Install"
- Digite:
n8n-nodes-william-crm - Clique em "Install"
Via npm (Manual)
# Para instalação global do n8n
npm install n8n-nodes-william-crm
# Para Docker
docker run -it --rm \
--name n8n \
-p 5678:5678 \
-e N8N_CUSTOM_EXTENSIONS="/home/node/.n8n/custom" \
-v n8n_data:/home/node/.n8n \
n8nio/n8n:latestVia Docker Compose
version: '3.8'
services:
n8n:
image: n8nio/n8n:latest
ports:
- "5678:5678"
environment:
- N8N_CUSTOM_EXTENSIONS=/home/node/.n8n/custom
volumes:
- n8n_data:/home/node/.n8n
command: >
/bin/sh -c "
npm install n8n-nodes-william-crm &&
n8n start
"
volumes:
n8n_data:⚙️ Configuração
1. Obter API Key do William CRM
- Acesse seu William CRM
- Vá em Configurações > API
- Clique em "Gerar Nova Chave"
- Copie a chave gerada (formato:
wcrm_...)
2. Configurar Credenciais no n8n
- No n8n, vá em Credentials
- Clique em "+ New"
- Selecione "William CRM API"
- Preencha:
- API URL:
https://seudominio.com/crm/api/v1.php - API Key:
wcrm_sua_chave_aqui
- API URL:
- Teste a conexão e salve
📖 Como Usar
🎯 Exemplo: Criar Lead Automaticamente
{
"nodes": [
{
"name": "Novo Lead",
"type": "n8n-nodes-william-crm.williamCrm",
"parameters": {
"operation": "create",
"resource": "leads",
"name": "João Silva",
"email": "[email protected]",
"phone": "(11) 99999-9999",
"origin": "Site",
"status": "new"
}
}
]
}🔄 Exemplo: Webhook + Criar Cliente
- Webhook Trigger recebe dados
- William CRM Node cria cliente:
{
"operation": "create",
"resource": "clients",
"name": "{{ $json.name }}",
"email": "{{ $json.email }}",
"phone": "{{ $json.phone }}",
"address": "{{ $json.address }}"
}📊 Exemplo: Sincronizar com Planilhas
Google Sheets → William CRM → Slack
{
"workflows": [
{
"trigger": "Google Sheets - New Row",
"action": "William CRM - Create Lead",
"notification": "Slack - Send Message"
}
]
}🎯 Operações Detalhadas
📋 Leads
create- Criar novo leadgetAll- Listar todos os leadsget- Buscar lead específicoupdate- Atualizar leaddelete- Excluir lead
👥 Clients
create- Criar novo clientegetAll- Listar todos os clientesget- Buscar cliente específicoupdate- Atualizar clientedelete- Excluir cliente
🚀 Projects
create- Criar novo projetogetAll- Listar projetosget- Buscar projeto específicoupdate- Atualizar projetoupdateStatus- Alterar statusdelete- Excluir projeto
📄 Proposals
create- Criar propostagetAll- Listar propostasget- Buscar proposta específicaupdate- Atualizar propostadelete- Excluir proposta
💰 Invoices
create- Criar faturagetAll- Listar faturasget- Buscar fatura específicaupdate- Atualizar faturamarkPaid- Marcar como pagadelete- Excluir fatura
🎫 Tickets
create- Criar ticketgetAll- Listar ticketsget- Buscar ticket específicoupdate- Atualizar ticketaddReply- Adicionar respostaclose- Fechar ticket
🔧 Desenvolvimento
Pré-requisitos
- Node.js 16+
- TypeScript 4.8+
- n8n 0.187.0+
Setup Local
# Clone o repositório
git clone https://github.com/williamschons/n8n-nodes-william-crm.git
cd n8n-nodes-william-crm
# Instale dependências
npm install
# Desenvolva com watch
npm run dev
# Build para produção
npm run build
# Lint e format
npm run lint
npm run formatEstrutura do Projeto
n8n-nodes-william-crm/
├── credentials/
│ └── WilliamCrmApi.credentials.ts
├── nodes/
│ └── WilliamCrm/
│ └── WilliamCrm.node.ts
├── dist/ (gerado)
├── package.json
├── tsconfig.json
└── README.md🤝 Contribuindo
- Fork o projeto
- Crie sua feature branch (
git checkout -b feature/NovaFuncionalidade) - Commit suas mudanças (
git commit -m 'Adiciona nova funcionalidade') - Push para a branch (
git push origin feature/NovaFuncionalidade) - Abra um Pull Request
📝 Licença
Este projeto está licenciado sob a MIT License - veja o arquivo LICENSE para detalhes.
🆘 Suporte
- 📧 Email: [email protected]
- 🌐 Site: https://williamschons.com.br
- 📖 Documentação: https://williamschons.com.br/docs/n8n-node
- 🐛 Issues: https://github.com/williamschons/n8n-nodes-william-crm/issues
🏷️ Changelog
v1.0.0 (2025-09-11)
- ✅ Lançamento inicial
- ✅ Suporte completo a todas as operações do CRM
- ✅ Autenticação via API Key
- ✅ TypeScript com tipagem completa
- ✅ Documentação integrada
Feito com ❤️ por William Schons
