Envio Leads via API
Instruções para envio de lead via API REST com exemplo de JSON e cURL.
Segue o endpoint API para recebimento de leads através do aplicações externas. Você pode utilizar esse endpoint, informando os campos conforme necessário. Veja o exemplo abaixo:
Envio dos Leads
Os leads deverão ser enviados via protocolo HTTP no verbo POST, passando um JSON com as informações do lead no endpoint que será fornecido para a conta do cliente Inforce.
IMPORTANTE: A URL final e tokens serão fornecida após implantação na conta do nosso cliente. Pode requerer contratação adicional, de acordo com o plano ou contrato do cliente.
URL Exemplo:
text
https://api.inforcehub.com.br/webhook/{contacliente}-{webhook}-{key}Método:
text
POSTJson Headers
json{ "Content-Type": "application/json", "X-Inforce-Account": "xxxxxxxxxxxxxxxxxx", "X-Inforce-Auth-Token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }
Json Body
json{ "origemExterna": "Site XYZ", "origemUrl": "https://lancamentoxyz.com.br", "produtoNome": "Residencial Lotus", "produtoImovel": "AP3058", "produtoEmpreendimento": "32", "interesseFinalidade": "comprar", "nome": "João da Silva Teste", "email": "teste@teste.com.br", "telefoneCelular": "55 21 999998888", "mensagem": "Teste API EXTERNA LEAD. Estou interessado no imóvel XYZ através da conversão XYZ...", "filialSlug": "porto-maravilha", "utm": "utm_source=google&utm_medium=cpc&utm_campaign=blackfriday&utm_id=777&utm_term=oferta&utm_content=ofertaxyz", "gclid": "Cj0KCQjw29CRBhCUARIsAOboZbLiqvyREx0195GvPIu9Xi05NS-zouT6LheyoY30iIThnS7EYVWyyFkaAjtQEALw_wcB", "fbclid": "PAAabWuJzLF9XS7riAOO0zp2Zmh6u8uytmiD0NBtHyU2B0eeA0tE1JGImRJUI" }
Documentação dos campos:
Segue a descrição dos campos que deverão ser enviados no corpo da requisição:
| Campo | Descrição |
|---|---|
| origemExterna | Essa informação será enviada pela Inforce. Ex: “Site 123” |
| origemUrl * | Url da página que originou o lead ex: https://lancamentoxyz.com.br |
| produtoNome | (Opcional) Código Imóvel ou Nome Lançamento. Ex: “AP2788” ou “Residencial Lotus” |
| produtoImovel | (Opcional) Código do Imóvel para associar automaticamente no lead. Ex: AP3058 |
| produtoEmpreemdimento | (Opcional) ID do Empreendimento na Inforce para associar automaticamente no lead. Ex: 32 |
| interesseFinalidade | (Opcional) “comprar” ou “alugar” |
| Nome * | João da Silva |
| Email * | É obrigatório 1 contato pelo menos, seja email ou telefoneCelular. |
| telefoneCelular * | 55 21 312321321 (DDI+DDD+TELEFONE). |
| mensagem | (Opcional) Aqui pode ser incluído mensagem do lead e/ou outros dados que sejam relevantes para o corretor atender no CRM. Campo de texto. |
| filialSlug | (Opcional) Slug da Filial no CRM Inforce |
| utm | (Opcional) Envio da UTM de rastreamento do tráfego |
| gclid | (Opcional) ID do Google para rastreamento ou mensuração de campanhas oriundas do Google |
| fbclid | (Opcional) ID do Facebook para rastreamento ou mensuração de campanhas oriundas da Meta / Facebook / Instagram |
! Campos obrigatórios estão sinalizados com *
cURL exemplo
curlcurl --location 'https://api.inforcehub.com.br/webhook/{contacliente}-{webhook}-{key}' \ --header 'Content-Type: application/json' \ --header 'X-Inforce-Account: xxxxxxxxxxxxxxxxxx' \ --header 'X-Inforce-Auth-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \ --data-raw '{ "origemExterna": "Site XYZ", "origemUrl": "https://lancamentoxyz.com.br", "produtoNome": "Residencial Teste", "produtoImovel": "AP3058", "produtoEmpreendimento": "32", "interesseFinalidade": "comprar", "nome": "João da Silva Teste", "email": "teste@teste.com.br", "telefoneCelular": "55 31 999998888", "mensagem": "Teste API EXTERNA LEAD. Estou interessado no imóvel XYZ através da conversão XYZ..." }'