vaicrm

Nó da comunidade N8N para integração com a API do VAI CRM (https://api.vaicrm.com.br/docs)

Package Information

Released: 2 mo ago
Downloads: 0 weekly / 0 monthly
Latest Version: 1.0.0

Available Nodes

Documentation generating…

VAI CRM icon
VAI CRM
Integração com a API do VAI CRM

Documentation

n8n-nodes-vaicrm

Nó da comunidade n8n para integração com a API do VAI CRM
(documentação oficial: https://api.vaicrm.com.br/docs).

O que está incluído

  • 61 recursos e 479 operações gerados a partir da especificação OpenAPI oficial:
    Contatos, Chats, Mensagens, Canais (WhatsApp, Telegram, Instagram, Messenger, E-mail...),
    Kanban, Tags, Atividades, Tarefas, Produtos, Campanhas, Agentes de IA, Webhooks,
    Usuários, Permissões, Relatórios, Dashboard, e muito mais.
  • Campos de path, query e body mapeados individualmente, com tipos corretos
    (texto, número, booleano, listas, JSON).
  • Suporte a upload de arquivos (multipart) via propriedade binária.
  • Autenticação por Token de API (vai_...) ou por e-mail e senha
    (login automático via POST /auth/login).

Instalação

Opção 1 — N8N self-hosted (pasta custom)

  1. Descompacte o ZIP em uma pasta temporária.
  2. Copie o conteúdo para a pasta de nodes customizados do N8N:
mkdir -p ~/.n8n/custom/n8n-nodes-vaicrm
# copie package.json, README.md e a pasta dist/ para lá
  1. Reinicie o N8N. O node VAI CRM aparecerá na lista de nodes.

Opção 2 — Docker

Monte a pasta descompactada no container:

volumes:
  - ./n8n-nodes-vaicrm:/home/node/.n8n/custom/n8n-nodes-vaicrm

Opção 3 — Instalação via npm (Community Nodes)

Se você publicar este pacote no npm, instale em
Settings → Community Nodes com o nome n8n-nodes-vaicrm.

Configuração das credenciais

Crie uma credencial do tipo VAI CRM API:

Campo Descrição
URL base Padrão: https://api.vaicrm.com.br
Autenticação Token de API (recomendado) ou E-mail e senha
Token de API Token criado no painel do VAI CRM (recurso "API Tokens"). Começa com vai_.

Dica: você pode criar um token de API pelo próprio node, usando a operação
API Tokens → Create (autenticando uma vez com e-mail e senha).

Uso

  1. Adicione o node VAI CRM ao workflow.
  2. Escolha o Recurso (ex.: Contacts) e a Operação (ex.: Find All).
  3. Preencha os parâmetros exibidos. Campos do tipo lista aceitam valores separados
    por vírgula; campos JSON aceitam objetos/arrays.
  4. Para operações de upload, envie o arquivo em uma propriedade binária do item
    anterior e informe o nome dela em Propriedade binária.

Paginação

Endpoints de listagem aceitam page e limit como parâmetros. Para buscar todas
as páginas, use um loop no workflow (ex.: node Loop + verificação de próxima página).

Limitações conhecidas

  • Gerado a partir da spec pública; endpoints marcados como obrigatórios seguem a spec.
  • Em uploads múltiplos (/files/upload/multiple), informe os nomes das propriedades
    binárias separados por vírgula.

Licença

MIT

Discussion