Integração via API

O Leadfy Imob disponibiliza o detalhamento de como você pode configurar suas landing pages a fim de nos mandar informações para o recebimento de Leads na app. Seguindo o descrito a seguir, seus novos Leads que chegarem por meio de requests JSON entram em nosso sistema por meio de um processamento padrão, não havendo a necessidade de solicitar um novo.

Deve-se seguir a disposição dos campo abaixo para que o payload seja processado de forma padrão em nosso sistema:

Campo	Tipo	Opções	Validação	Obrigatório
nome	string	Campo aberto	Não há validação	Não
telefone	string	Campo aberto	Telefone	Sim (ou E-mail)
telefone2	string	Campo aberto	Telefone	Não
email	string	Campo aberto	E-mail	Sim (ou Telefone)
fgts	string	Sim; Não;	Opções ou vazio	Não
endereco	string	Campo aberto	Não há validação	Não
bairro	string	Campo aberto	Não há validação	Não
cidade	string	Campo aberto	Não há validação	Não
estado	string	Campo aberto	Não há validação	Não
descricao	string	Campo aberto	Não há validação	Não
preco	string	Campo aberto	Não há validação	Não
negociacao	string	Compra; Aluguel;	Opções ou vazio	Não
link	string	Campo aberto	URI	Não
mensagem	string	Campo aberto	Não há validação	Não
observacao	string	Campo aberto	Não há validação	Não
origem	string	Campo aberto	Não há validação	Não
tag	string	Campo aberto	Não há validação	Não

Exemplificando, um payload enviado corretamente para nossa plataforma seria construído de forma:

{
  "nome": "Antonio Silva",
  "telefone": "15 91233 1233",
  "telefone2": "15 91236 1235",
  "email": "antonio@gmail.com",
  "fgts": "Sim",
  "endereco": "Rua das Árvores, 31",
  "bairro": "Centro",
  "cidade": "São Paulo",
  "estado": "SP",
  "descricao": "Apartamento Duplex próx. a Av. Paulista, 250m2",
  "preco": "R$ 3.000.000,00",
  "negociacao": "Compra",
  "link": "https://www.vivareal.com.br/imovel/apartamento-centro/",
  "mensagem": "Olá, me interessei pelo Ap., gostaria de marcar uma visita.",
  "observacao": "Lead já tratado pelo Marcos.",
  "origem": "Vivareal",
  "tag": "nome-da-tag"
}

O request JSON deverá ser formulado nos seguintes parâmetros para ser reconhecido em nossos servidores:

Verbo:	POST
URL:	https://leadfy-imob.com.br/webhooks/criar_lead/IDENTIFICADOR/
Content Type:	application/json

Para esse tipo de integração, temos um IDENTIFICADOR que será utilizado na URL do request JSON. Obrigatoriamente, há duas formas de se compor ele, que são:

1. Utilizando um hash da empresa composto de 10 caracteres alfanuméricos, em que os leads serão entregues para o rodízio geral de distribuição. Ele deve ser requisitado com a Equipe de Suporte do aplicativo e é utilizado da seguinte forma: IDENTIFICADOR = HASH DA EMPRESA
2. Utilizando um hash de grupo composto por 6 caracteres alfanuméricos, em que os leads serão entregues direcionados para um grupo específico e seu próprio rodízio interno. Ele deve ser requisitado com a Equipe de Suporte do aplicativo e é utilizado da seguinte forma: IDENTIFICADOR = grp-HASH DO GRUPO

Opcionalmente, é possível definir um impulsionador para esses leads direto no IDENTIFICADOR. Isso é feito também por um hash composto por 6 caracteres alfanuméricos, que deve ser requisitado à Equipe de Suporte do aplicativo e é adicionado à frente da parte obrigatória:

1. Quando se opta pelo hash da empresa, é utilizado da seguinte forma: IDENTIFICADOR = HASH DA EMPRESA-cap-HASH DO IMPULSIONADOR
2. Quando se opta pelo hash do grupo, é utilizado da seguinte forma: IDENTIFICADOR = grp-HASH DO GRUPO-cap-HASH DO IMPULSIONADOR

Exemplificando, o IDENTIFICADOR poderá ser escrito das seguintes formas:

Direcionamento	Identificador	Exemplo prático
Empresa	HASH DA EMPRESA	18952qf65x
Grupo	grp-HASH DO GRUPO	grp-8756ed
Empresa + Impulsionador	HASH DA EMPRESA-cap-HASH DO IMPULSIONADOR	18952qf65x-cap-5687rf
Grupo + Impulsionador	grp-HASH DO GRUPO-cap-HASH DO IMPULSIONADOR	grp-8756ed-cap-5687rf

Exemplo de request curl:

curl -v -XPOST -H 'Content-Type: application/json' -d'{"name": "Teste", "phone": "11992837474"}' https://leadfy-imob.com.br/webhooks/criar_lead/grp-ib5dfw-cap-o0e22d/

---

Caso tenha quaisquer outras dúvidas, entre em contato com a nossa Equipe de Suporte pela App.