n8n-nodes-rd-station-crm

Este pacote contém nós personalizados para integrar o n8n com a API do RD Station CRM (versão 1).

Visão Geral

Este projeto consiste em um conjunto de nós personalizados do n8n para integrar completamente com a API do RD Station CRM (versão 1). Diferente da API de Marketing do RD Station, a API do CRM possui endpoints próprios, e todas as requisições são feitas diretamente ao RD Station CRM.

Os nós desenvolvidos cobrem as principais entidades do RD Station CRM:

• Contatos
• Negócios (Deals)
• Tarefas
• Anotações (Notas)
• Empresas
• Produtos em Negociações
• Usuários
• Equipes
• Funis de Vendas e Etapas
• Motivos de Perda
• Campanhas
• Fontes (origem dos leads)
• Webhooks do CRM

Instalação

Para instalar este pacote em uma instância self-hosted do n8n, execute:

npm install n8n-nodes-rd-station-crm

Instalação para Desenvolvimento

Para desenvolvimento, você pode clonar este repositório e fazer um link simbólico para o diretório de nós personalizados do n8n:

# Clone o repositório
git clone https://github.com/seu-usuario/n8n-nodes-rd-station-crm.git

# Entre no diretório
cd n8n-nodes-rd-station-crm

# Instale as dependências
npm install

# Compile o código
npm run build

# Crie um link simbólico (Windows)
mklink /D %APPDATA%\.n8n\custom\n8n-nodes-rd-station-crm <caminho-completo-para-o-diretório>\dist

# Crie um link simbólico (Linux/Mac)
ln -s $(pwd)/dist ~/.n8n/custom/n8n-nodes-rd-station-crm

Autenticação e Credenciais

A autenticação com o RD Station CRM é feita através de um token privado de API. Cada usuário do RD CRM possui um token único de API que deve ser utilizado para autenticação.

Para configurar as credenciais:

1. No n8n, acesse o menu "Credenciais"
2. Clique em "Adicionar Credencial"
3. Selecione "RD Station CRM API"
4. Insira o token privado do RD Station CRM
5. Clique em "Salvar"

Observação: O token de API herda as permissões do usuário no CRM. Isso significa que os resultados de algumas operações podem ser limitados pelo nível de visibilidade do usuário dono do token (Restrito, Equipe ou Geral).

Nós Disponíveis e Funcionalidades

Contatos (RD Station CRM Contatos)

Operações disponíveis:

• Listar Contatos: Retorna uma lista paginada de contatos do CRM.
• Obter Contato: Retorna detalhes de um contato específico por ID ou e-mail.
• Criar Contato: Cria um novo contato no CRM com os dados fornecidos.
• Atualizar Contato: Atualiza um contato existente identificado por ID ou e-mail.

Negócios (RD Station CRM Negócios)

Operações disponíveis:

• Listar Negócios: Lista os negócios/oportunidades registrados.
• Criar Negócio: Registra uma nova oportunidade de venda.
• Atualizar Negócio: Atualiza campos de uma negociação existente.
• Obter Negócio: Obtém detalhes de um negócio específico.
• Listar Contatos de um Negócio: Retorna todos os contatos associados a uma negociação.

Tarefas (RD Station CRM Tarefas)

Operações disponíveis:

• Listar Tarefas: Lista tarefas pendentes ou concluídas.
• Criar Tarefa: Cria uma nova tarefa associada a um negócio.
• Atualizar Tarefa: Atualiza uma tarefa existente (ex: marcar como concluída).
• Obter Tarefa: Obtém detalhes de uma tarefa específica.

Anotações (RD Station CRM Notas)

Operações disponíveis:

• Listar Notas: Lista todas as anotações de negociações.
• Criar Nota: Adiciona uma nova anotação a um negócio.

Empresas (RD Station CRM Empresas)

Operações disponíveis:

• Listar Empresas: Lista empresas cadastradas.
• Criar Empresa: Cria um novo registro de empresa.
• Atualizar Empresa: Atualiza dados de uma empresa existente.
• Obter Empresa: Consulta detalhes de uma empresa por ID.
• Listar Contatos da Empresa: Retorna todos os contatos vinculados a uma empresa específica.

Produtos em Negociações (RD Station CRM Produtos em Negócios)

Operações disponíveis:

• Listar Produtos de uma Negociação: Retorna os produtos associados a um determinado negócio.
• Adicionar Produtos a Negociação: Permite adicionar um ou vários produtos a uma negociação.
• Atualizar Produtos da Negociação: Atualiza em massa os produtos vinculados.
• Remover Produto(s) da Negociação: Remove um ou mais produtos de uma negociação.

Usuários (RD Station CRM Usuários)

Operações disponíveis:

• Listar Usuários: Retorna a lista de usuários da conta do CRM.
• Obter Usuário: Retorna detalhes de um usuário específico por ID.

Equipes (RD Station CRM Equipes)

Operações disponíveis:

• Listar Equipes: Retorna todas as equipes cadastradas na conta.
• Obter Equipe: Obtém detalhes de uma equipe específica.

Funis e Etapas (RD Station CRM Funis)

Operações disponíveis para Funis:

• Listar Funis: Retorna os funis de vendas existentes.
• Obter Funil: Obtém detalhes de um funil específico.

Operações disponíveis para Etapas:

• Listar Etapas: Obtém as etapas de um funil específico.
• Obter Etapa: Obtém detalhes de uma etapa específica.

Motivos de Perda (RD Station CRM Motivos de Perda)

Operações disponíveis:

• Listar Motivos de Perda: Retorna os motivos de perda cadastrados.
• Obter Motivo de Perda: Obtém detalhes de um motivo de perda específico.

Campanhas (RD Station CRM Campanhas)

Operações disponíveis:

• Listar Campanhas: Retorna as campanhas cadastradas.
• Obter Campanha: Obtém detalhes de uma campanha específica.

Fontes (RD Station CRM Fontes)

Operações disponíveis:

• Listar Fontes: Retorna as fontes de lead cadastradas.
• Obter Fonte: Obtém detalhes de uma fonte específica.

Webhooks (RD Station CRM Webhooks)

Operações disponíveis:

• Listar Webhooks: Lista todos os webhooks cadastrados no CRM.
• Criar Webhook: Cadastra um novo webhook.
• Obter Webhook: Obtém detalhes de um webhook específico.
• Atualizar Webhook: Altera a configuração de um webhook existente.
• Deletar Webhook: Remove um webhook cadastrado.

Exemplos de Uso

Exemplo 1: Criar contato e associá-lo a um negócio

1. Use o nó "RD Station CRM Contatos" com a operação "Criar" para criar um novo contato.
2. Use o nó "RD Station CRM Negócios" com a operação "Criar" e associe o ID do contato criado.

Exemplo 2: Gerar relatório de negócios por etapa

1. Use o nó "RD Station CRM Funis" com a operação "Listar" para obter os funis disponíveis.
2. Use o nó "RD Station CRM Negócios" com a operação "Listar" e filtre por funil específico.
3. Processe os dados com nós de funções do n8n para agrupar por etapa.

Exemplo 3: Criar tarefas automaticamente para novos negócios

1. Configure um webhook no RD Station CRM para "Negócio Criado".
2. No n8n, use um nó de webhook para receber a notificação.
3. Use o nó "RD Station CRM Tarefas" com a operação "Criar" para criar uma tarefa de acompanhamento.

Estado Atual do Projeto

Os seguintes nós foram implementados e estão funcionais:

1. RdStationCrmContacts - Gerenciamento de contatos
2. RdStationCrmDeals - Gerenciamento de negócios
3. RdStationCrmTasks - Gerenciamento de tarefas
4. RdStationCrmNotes - Gerenciamento de anotações
5. RdStationCrmCompanies - Gerenciamento de empresas
6. RdStationCrmDealProducts - Gerenciamento de produtos em negociações
7. RdStationCrmUsers - Consulta de usuários
8. RdStationCrmTeams - Consulta de equipes
9. RdStationCrmPipelines - Consulta de funis e etapas
10. RdStationCrmLossReasons - Consulta de motivos de perda
11. RdStationCrmCampaigns - Consulta de campanhas
12. RdStationCrmSources - Consulta de fontes
13. RdStationCrmWebhooks - Gerenciamento de webhooks

Limitações Atuais

Os nós implementados permitem principalmente operações de consulta e criação de recursos. Algumas operações de atualização e exclusão podem ser limitadas pela API do RD Station CRM, que restringe certas operações através da API, permitindo que sejam realizadas apenas pela interface do usuário.

Próximos Passos

1. Adicionar suporte para campos personalizados em todos os nós relevantes
2. Desenvolver fluxos de trabalho de exemplo para casos de uso comuns
3. Implementar operações de criação em massa para otimizar a importação de dados
4. Melhorar a documentação com exemplos visuais e tutoriais
5. Implementar testes automatizados para garantir a qualidade do código

Documentação Adicional

Para mais detalhes sobre a API do RD Station CRM, consulte a documentação oficial.

Limitações Conhecidas

• Alguns endpoints podem não estar disponíveis em todos os planos do RD Station CRM.
• As operações dependem das permissões do usuário dono do token de API.
• Não é possível excluir diretamente contatos, negócios ou tarefas pela API.

Licença

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