API de Integração de Leads com ImobiBrasil: Documentação

Como podemos te ajudar?
< Voltar a Listagem
Imprimir

API de Integração de Leads com ImobiBrasil: Documentação

Postado11 de setembro de 2023
Atualizado5 de fevereiro de 2025
Porajudaimobi

Esta documentação se destina a desenvolvedores de portais imobiliários e CRMs que desejam integração com a ImobiBrasil.

Este post serve como um guia completo para a integração da API de leads com ImobiBrasil. Aqui você encontrará informações sobre como enviar dados de leads para nosso sistema.

Endpoint

Para enviar dados de leads, faça uma requisição POST para o seguinte endpoint:

POST https://admin01.imobibrasil.net/feed/integracao_leads_imobibrasil/integracao_api.php

Headers

Inclua os seguintes headers na sua requisição:

Content-Type: application/json
token: Seu_Token_Aqui

Corpo da Requisição

O corpo da requisição deve conter um objeto JSON com as seguintes propriedades:

nome (string): Nome do lead.

email (string): E-mail do lead.

telefone (string): Telefone do lead.

mensagem (string): Conteúdo da mensagem ou descrição.

links (array): Os links serão concatenados no final da mensagem.

referencia (string): Referência do imóvel no CRM ImobiBrasil.

captação (string): Origem de onde veio o lead.

origem (string): Origem do lead (dado fornecido pela imobibrasil para os parceiros integrados).

website (string): Website da imobiliária ou corretor cliente ImobiBrasil.

temperatura (string): Os tipos frio, morno, quente ou muito quente são utilizados para qualificar os leads. caso não seja enviado nenhum tipo, o lead é cadastrado como não qualificado.

Exemplo de Corpo da Requisição

{ 
"nome": "Maria José João 4", 
"email": "testecnm@teste2.com.br", 
"telefone": "(11) 97274-6653", 
"mensagem": "Localização: Jacareí Tipo: Venda Faixa de preço: Até R$200.000,00 Resumo: O cliente busca por imóveis que se enquadrem no MCMV, com preferência por aqueles que possuem sacada e recebem sol da manhã. No momento, não há opções disponíveis em Jacareí, mas o cliente está interessado em ser contatado quando surgirem novas ofertas. Temperatura: MORNO Imóveis que o cliente se interessou: 1.",
"links": [
    {
        "titulo" : "Você pode ler a conversa completa através do link:",
        "descricao": "Link Personalizado",
        "url": "https://lais.ai/chat"
    }, 
    {
        "titulo" : "Você pode atender o usuário através do link:",
        "url": "https://wa.me/tel"
    }   
] ,
"referencia": "425311", 
"captacao": "Grupo Zap",
"origem": "lais", 
"website": "www.imobbrasil.com.br" ,
"temperatura": "quente"
}

Exemplos de Resposta

Resposta de Sucesso (HTTP 200)

{ 
"status": true, 
"data": "Lead Inserido com sucesso." 
}

Resposta de Erro – Token Inválido (HTTP 400)

{ 
"status": false, 
"errors": ["Token inválido."] 
}

Resposta de Erro – Dados Inválidos (HTTP 400)

{ 
 "status": false, 
 "errors": 
  [ 
  "Informe o nome do contato.", 
  "O campo nome tem que ser no máximo 70 caracteres." 
  ] 
}

Resposta de Erro – Autenticação (HTTP 401)

Sem corpo de resposta.

Resposta de Erro Interno (HTTP 500)

Sem corpo de resposta.

Como obter um token

O envio de leads para o sistema ImobiBrasil é destinado apenas para portais parceiros e ferramentas que desejam integrar conosco, por exemplo, portais imobiliários e sistemas de CRM. Para obter um token de acesso entre em contato com nosso suporte em: contato@imobibrasil.com.br

Sou cliente ImobiBrasil, posso usar essa API exclusivamente para conectar os funis de conversão da minha imobiliária?

No momento não, porém estamos trabalhando para disponibilizar uma integração exclusiva via API destinada aos clientes ImobiBrasil. Caso tenha dúvidas ou sugestões entre em contato.

Exceções e Regras

Todos os campos são obrigatórios.

O token deve ser válido e ativo.

O website informado deve existir no sistema.

O cadastro não deve estar bloqueado no sistema.

Sumário