N8N ViaCEP Community Node

Community Node para N8N que permite consultar informações de CEP usando a API do ViaCEP.

Funcionalidades

• Consultar CEP: Busca informações detalhadas de um CEP específico
• Buscar por Endereço: Encontra CEPs baseado em UF, cidade e logradouro
• Suporte a JSON e XML: Escolha o formato de retorno
• Tratamento de Erros: Validação de entrada e tratamento de erros da API

Instalação

Para instalar este node em sua instância do N8N:

npm install n8n-nodes-viacep-br

Desenvolvimento

Pré-requisitos

• Node.js (versão 16 ou superior)
• npm ou yarn

Setup

1. Clone o repositório

2. Instale as dependências:

   npm install

3. Compile o projeto:

   npm run build

Scripts Disponíveis

• npm run build - Compila o TypeScript e copia os ícones
• npm run dev - Modo de desenvolvimento com watch
• npm run lint - Executa o linter
• npm run format - Formata o código

Estrutura do Projeto

├── nodes/                # Nodes do N8N
│   └── ViaCep/          # Node do ViaCEP
├── dist/                 # Arquivos compilados
├── package.json          # Configurações do npm
└── tsconfig.json         # Configurações do TypeScript

Como Usar

Consultar CEP

1. Adicione o node "ViaCEP" ao seu workflow
2. Selecione a operação "Consultar CEP"
3. Informe o CEP (formato: 12345-678 ou 12345678)
4. Execute o workflow

Exemplo de retorno:

{
  "cep": "01310-100",
  "logradouro": "Avenida Paulista",
  "complemento": "",
  "bairro": "Bela Vista",
  "localidade": "São Paulo",
  "uf": "SP",
  "ibge": "3550308",
  "gia": "1004",
  "ddd": "11",
  "siafi": "7107"
}

Buscar por Endereço

1. Selecione a operação "Buscar por Endereço"
2. Informe UF (2 letras), cidade e logradouro (mín. 3 caracteres)
3. Execute o workflow

Exemplo:

• UF: SP
• Cidade: São Paulo
• Logradouro: Paulista

Retorna uma lista com todos os CEPs encontrados para o endereço.

Contribuição

1. Fork o projeto
2. Crie uma branch para sua feature
3. Commit suas mudanças
4. Push para a branch
5. Abra um Pull Request

Licença

MIT