n8n-nodes-imobzi/README.md

Nodes para integração com a API da Imobzi no n8n

![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)

# n8n-nodes-imobzi

Pacote de nodes para integração completa do n8n com a API Imobzi. Todos os recursos reais da plataforma, documentação em português e exemplos práticos.

## Sumário
- [Instalação](#instalação)
- [Configuração](#configuração)
- [Recursos Disponíveis](#recursos-disponíveis)
- [Exemplos Práticos](#exemplos-práticos)
- [Contribuição](#como-contribuir)

## O que é?
Nodes para integração do n8n com a API da Imobzi, incluindo automações, webhooks e CRM imobiliário.

---

## Instalação

```bash
npm install -g n8n-nodes-imobzi
```

Após instalar, **reinicie o n8n** para que os nodes apareçam.

---

## Configuração de Credenciais

1. No n8n, vá em **Settings > Credentials**
2. Clique em **Add Credential** e escolha **Imobzi API**
3. Preencha:
   - **API Key**: Sua chave da Imobzi (pegue no painel Imobzi em Configurações > API)
   - **Environment**: Production ou Sandbox
4. Salve

---

## Nodes Disponíveis

### 1. Imobzi (Ações/Consulta)
- **Leads**: Criar, obter, listar, atualizar
- **Imóveis**: Criar, obter, listar, atualizar
- **Contatos**: Criar, obter, listar, atualizar
- **Conta**: Obter informações

#### Como usar:
- Adicione o node **Imobzi** no seu workflow
- Escolha o recurso (Lead, Imóvel, Contato, Conta)
- Escolha a operação (Create, Get, Get Many, Update)
- Preencha os campos obrigatórios
- Conecte com outros nodes conforme sua automação

### 2. Imobzi Webhook (Trigger)
- Recebe eventos da Imobzi (ex: lead criado, imóvel atualizado, etc)
- Gera uma URL de webhook para ser cadastrada no painel da Imobzi

#### Como usar o Webhook:
1. Adicione o node **Imobzi Webhook** no seu workflow
2. Salve o workflow e copie a URL do webhook exibida pelo n8n
3. No painel da Imobzi, vá em **Configurações > Webhooks**
4. Cole a URL e selecione os eventos desejados (ex: Lead Criado)
5. Agora, sempre que o evento ocorrer, o n8n receberá os dados automaticamente

---

## Exemplos de Uso

### Criar um Lead
```json
{
  "name": "João Silva",
  "email": "joao@email.com",
  "phone": "+5511999999999"
}
```

### Webhook de Lead Criado
Quando um lead for criado na Imobzi, o payload recebido será:
```json
{
  "event": "lead.created",
  "timestamp": "2024-01-01T10:00:00Z",
  "data": {
    "id": "lead_123",
    "name": "João Silva",
    "email": "joao@email.com",
    "phone": "+5511999999999",
    "created_at": "2024-01-01T10:00:00Z"
  }
}
```

### Exemplo de Workflow
1. Adicione o **Imobzi Webhook** como trigger
2. Conecte com o node **Imobzi** para criar um contato ou atualizar um lead
3. Adicione nodes de lógica (If, Set, HTTP Request, etc) conforme sua automação

---

## Dicas e Troubleshooting
- Sempre reinicie o n8n após instalar ou atualizar o pacote.
- Use o ambiente **Sandbox** para testes.
- Se o node não aparecer, confira se o diretório global do npm está no PATH do seu sistema.
- Se o webhook não receber eventos, confira se a URL está correta e acessível pela internet.
- Consulte a [documentação oficial da API Imobzi](https://developer.imobzi.com/).

---

## Links Úteis
- **Documentação da API Imobzi**: https://developer.imobzi.com/
- **Repositório GitHub**: https://github.com/minutare/n8n-nodes-imobzi
- **Pacote no npm**: https://www.npmjs.com/package/n8n-nodes-imobzi

---

## Suporte
- Email: contato@minutare.com
- Issues: https://github.com/minutare/n8n-nodes-imobzi/issues

---

**Desenvolvido por Minutare**