n8n-nodes-imobzi

Este é um pacote de nodes da comunidade n8n que permite integrar com a API da Imobzi em seus workflows.

A Imobzi é uma plataforma de CRM imobiliário que oferece uma API aberta para integração com outros softwares. Para utilizar a API, é necessário possuir o plano CRM Business ou a Gestão de Locação Real Estate.

n8n é uma plataforma de automação de workflows com licença fair-code.

Instalação
Configuração
Recursos
Operações
Webhooks
Exemplos
Compatibilidade
Recursos

Instalação

Siga o guia de instalação na documentação dos nodes da comunidade n8n.

npm install -g n8n-nodes-imobzi

Configuração

1. Gerar Chave de API no Imobzi

1. Acesse o menu lateral do Imobzi
2. Clique em "Integrações & Automações"
3. Selecione "Chave de API"
4. Clique em "Adicionar uma nova chave de API"
5. Nomeie a chave conforme o serviço que irá utilizá-la
6. Copie a chave gerada

Para mais detalhes, consulte: Como funciona a chave de API

2. Configurar Permissões da Chave de API

1. Ao criar ou editar uma chave de API, defina exatamente quais métodos (funções) a integração poderá acessar
2. Marque os métodos desejados ou utilize a opção "Selecionar todos os métodos" para liberar todas as funções

3. Configurar Credenciais no n8n

1. No n8n, vá para Settings > Credentials
2. Clique em Add Credential
3. Procure por "Imobzi API"
4. Configure:
   • API Key: Cole a chave gerada no Imobzi

Recursos

O node suporta os seguintes recursos da API da Imobzi:

| Recurso | Endpoint | Descrição | |---------|----------|-----------| | Account | /v1/account | Informações da conta | | Leads | /v1/leads | Gerenciamento de leads | | Properties | /v1/properties | Gerenciamento de imóveis | | Contacts | /v1/contacts | Gerenciamento de contatos | | Contracts | /v1/contracts | Gerenciamento de contratos | | Financial | /v1/financial/accounts | Contas financeiras | | Rentals | /v1/rentals | Gerenciamento de locações | | Documents | /v1/documents | Gerenciamento de documentos | | Tasks | /v1/tasks | Gerenciamento de tarefas | | Agendas | /v1/agendas | Gerenciamento de agendas | | Events | /v1/events | Gerenciamento de eventos | | Integrations | /v1/integrations | Integrações configuradas | | Users | /v1/users | Gerenciamento de usuários |

Operações

Cada recurso suporta as seguintes operações:

Create

Cria um novo item no recurso selecionado.

Campos específicos por recurso:

Leads

• name - Nome do lead
• email - Email do lead
• phone - Telefone do lead
• description - Descrição do lead
• source - Origem do lead
• status - Status do lead

Properties

• title - Título do imóvel
• type - Tipo do imóvel (casa, apartamento, etc.)
• price - Preço do imóvel
• address - Endereço do imóvel
• city - Cidade do imóvel
• state - Estado do imóvel

Contacts

• name - Nome do contato
• email - Email do contato
• phone - Telefone do contato
• description - Descrição do contato
• company - Empresa do contato

Tasks

• title - Título da tarefa
• description - Descrição da tarefa
• dueDate - Data de vencimento
• priority - Prioridade da tarefa

Events

• title - Título do evento
• description - Descrição do evento
• startDate - Data de início
• endDate - Data de término

Get

Obtém um item específico por ID.

Get All

Lista todos os itens do recurso com suporte a:

• Filtros dinâmicos: Baseados nos campos reais da API
• Operadores: igual, diferente, maior que, menor que, contém, etc.
• Ordenação: Por campo específico
• Paginação: Limit e offset

Update

Atualiza um item existente por ID.

Delete

Remove um item por ID.

Webhooks

O node webhook permite receber notificações em tempo real sobre eventos específicos no Imobzi.

Eventos Suportados

• lead.created - Lead criado
• lead.updated - Lead atualizado
• property.created - Imóvel criado
• property.updated - Imóvel atualizado
• contact.created - Contato criado
• contact.updated - Contato atualizado
• visit.scheduled - Visita agendada
• visit.cancelled - Visita cancelada
• task.created - Tarefa criada
• task.updated - Tarefa atualizada
• event.created - Evento criado
• event.updated - Evento atualizado
• contract.created - Contrato criado
• contract.updated - Contrato atualizado
• document.created - Documento criado
• document.updated - Documento atualizado

Configuração de Webhooks

Para configurar webhooks na Imobzi:

1. Acesse o painel da Imobzi
2. Vá para Configurações > Webhooks
3. Adicione uma nova URL de webhook
4. Selecione os eventos que devem acionar o webhook

Para um guia completo, consulte: Como criar e usar webhooks na Imobzi

Exemplos

Exemplo 1: Criar Lead Automaticamente

1. Adicione o Imobzi Webhook como trigger
2. Configure para eventos de "Lead Criado"
3. Conecte com o Imobzi Node
4. Configure para criar um contato baseado no lead

Exemplo 2: Sincronizar Imóveis

1. Use um Cron ou Schedule trigger
2. Conecte com Imobzi Node (Get All Properties)
3. Processe os dados conforme necessário

Exemplo 3: Filtrar Imóveis por Preço

{
  "resource": "property",
  "operation": "getAll",
  "filters": {
    "filter": [
      {
        "field": "price",
        "operator": "gte",
        "value": "100000"
      }
    ]
  }
}

Compatibilidade

• n8n: Versão mínima 1.0.0
• Node.js: >=20.15
• Plano Imobzi: CRM Business ou Gestão de Locação Real Estate

Recursos

• Documentação da comunidade n8n
• Documentação da API Imobzi
• Como funciona a chave de API
• Como utilizar a API para integrar com aplicativos externos
• Como criar e usar webhooks na Imobzi

Histórico de Versões

v0.3.47

• ✅ Endpoints corrigidos para usar /v1/ conforme documentação oficial
• ✅ URL base corrigida para https://api.imobzi.com
• ✅ Autenticação Bearer Token implementada
• ✅ Campos específicos por recurso implementados
• ✅ Webhooks com eventos oficiais da API
• ✅ Filtros dinâmicos funcionais
• ✅ Todos os erros de linting corrigidos

v0.3.46

• Implementação inicial dos filtros dinâmicos
• Correção de endpoints da API

v0.3.45

• Implementação de campos dinâmicos para criação e atualização
• Correção de métodos loadOptions

Criado por: Minutare
Versão: 0.3.47
Última atualização: Janeiro 2024