kipflow

n8n node for Kipflow CNPJ enrichment

Package Information

Downloads: 29 weekly / 827 monthly
Latest Version: 2.0.0
Author: Kipflow

Documentation

n8n-nodes-kipflow

Este é um node customizado do n8n para enriquecimento de dados de empresas brasileiras usando CNPJ através da API do Kipflow.

Instalação

Para uso no n8n

Instalação via npm (Community Node)

  1. No n8n, vá em Settings > Community Nodes
  2. Clique em Install Community Node
  3. Digite: n8n-nodes-kipflow
  4. Clique em Install

Instalação manual

npm install n8n-nodes-kipflow

Para desenvolvimento

# Clone o repositório
git clone https://github.com/Kipflow/n8n-kipflow-node.git
cd n8n-kipflow-node

# Instale as dependências
npm install

# Compile o projeto
npm run build

# Para desenvolvimento com watch mode
npm run dev

Configuração

  1. Obtenha sua API Key em Kipflow
  2. No n8n, adicione uma nova credencial do tipo "Kipflow API"
  3. Cole sua API Key

Uso

O node Kipflow CNPJ Enrichment enriquece dados de empresas brasileiras usando o CNPJ.

Parâmetros

  • CNPJ: O CNPJ da empresa (com ou sem formatação)
  • Datasets: Selecione os datasets que deseja obter:
    • Básico (R$ 0,02) - Dados básicos da empresa
    • Completo (R$ 0,24) - Dados completos
    • Endereço (R$ 0,07) - Informações de endereço
    • Presença Online (R$ 0,12) - Website, redes sociais, etc.
    • Sócios (R$ 0,08) - Informações sobre os sócios

Exemplo de Resposta

{
  "success": true,
  "data": {
    "cnpj": "12345678000190",
    "razao_social": "Empresa Exemplo LTDA",
    "nome_fantasia": "Exemplo",
    "situacao": "ATIVA",
    ...
  }
}

Scripts disponíveis

Desenvolvimento

  • npm run build - Compila o projeto
  • npm run dev - Compila em modo watch
  • npm run lint - Verifica problemas no código
  • npm run lint:fix - Corrige problemas automaticamente
  • npm run format - Formata o código

Versionamento (após commit das alterações)

  • npm run release:patch - Correções de bugs (1.0.1 → 1.0.2)
  • npm run release:minor - Novas funcionalidades (1.0.1 → 1.1.0)
  • npm run release:major - Breaking changes (1.0.1 → 2.0.0)

Desenvolvimento e Contribuição

Para contribuir com o projeto ou fazer releases, consulte o Guia de Contribuição.

O guia inclui:

  • 🛠️ Como configurar o ambiente de desenvolvimento
  • 🚀 Fluxo completo de versionamento e releases
  • 📝 Padrões de código e commits
  • ✅ Checklist antes de fazer um release

Estrutura do Projeto

n8n-nodes-kipflow/
├── credentials/
│   ├── KipflowApi.credentials.ts
│   └── DrivaSearchApi.credentials.ts
├── nodes/
│   └── KipflowCnpjEnrichment/
│       ├── KipflowCnpjEnrichment.node.ts
│       ├── KipflowCnpjEnrichment.node.json
│       └── kipflow-logo.svg
├── dist/                      # Arquivos compilados
├── package.json
├── tsconfig.json
├── gulpfile.js
├── .eslintrc.js
├── .prettierrc
└── README.md

Licença

MIT

Suporte

Discussion