Estamos disponibilizando neste repositório o manual de Integração de Leads do Grupo ZAP. Este documento contém as informações para que os Softwares/CRMs realizem as integrações com nossa API. Assim, o anunciante poderá receber os seus contatos(leads) no CRM.
Nosso sistema de integração de leads precisa de uma URL (Endpoint) para enviar as informações do lead para os Softwares/CRMs homologados. Esta requisição será realizada via protocolo HTTP no verbo POST, no Endpoint especificado passando um JSON como corpo do request.
Abaixo exemplos de endpoints que poderão ser utilizados:
https://yourdomain.com.br/grupozap/lead/ID-DO-ANUNCIANTE
Ex: https://crm-ou-imobiliaria.com.br/grupozap/lead/123456
OU
https://ID-DO-ANUNCIANTE.yourdomain.com.br/grupozap/lead
Ex: https://imobiliariaxpto.crm.com.br/grupozap/lead
ID-DO-ANUNCIANTE é parte da URL que representa o identificador do anunciante no sistema que irá receber a requisição. É uma forma de identificação do cliente no Software/CRM.
Caso não tenha ou não queira especificar o ID-DO-ANUNCIANTE o endpoint poderá ser implementado sem este identificador.
Ex: https://yourdomain.com.br/grupozap/lead
Utilizando um único endpoint, o Software/CRM deverá identificar o cliente pelo clientListingId, mais detalhes abaixo:
Os leads serão enviados via protocolo HTTP no verbo POST, passando um JSON com as informações do lead no endpoint especificado e homologado por nosso time.
O processo de integração será acionado para cada lead individualmente sempre que recebermos um contato do usuário. Nosso controle de sucesso de envio dos leads será feito através dos códigos de status do protocolo HTTP da seguinte forma:
2xx: indica que o Software/CRM recebeu o lead com sucesso e que ações adicionais não são necessárias. Qualquer código de status da família 200 terá esse efeito. 3xx, 4xx ou 5xx: indica que houve falha no processamento do lead por parte do Software/CRM.
Caso o endpoint do Software/CRM retorne qualquer código de status que não são da família 200, haverá retentativa automática no envio do lead. O reenvio será executado por 3 vezes e, caso não haja sucesso, ele será armazenado temporariamente por até 14 dias, podendo ser reenviado a pedido do Software/CRM.
O controle do status de recebimento dos leads será feito exclusivamente através dos códigos de status do protocolo HTTP. Qualquer informação enviada no corpo da resposta será totalmente ignorada!
Contrato JSON:
{
"leadOrigin": "VivaReal",
"timestamp": "2017-10-23T15:50:30.619Z",
"originLeadId": "59ee0fc6e4b043e1b2a6d863",
"originListingId": "87027856",
"clientListingId": "a40171",
"name": "Nome Consumidor",
"email": "[email protected]",
"ddd": "11",
"phone": "999999999",
"phoneNumber": "11999999999",
"message": "Olá, tenho interesse neste imóvel. Aguardo o contato. Obrigado."
}Onde:
- leadOrigin: Identificador do contrato do anunciante (VivaReal, Zap, GrupoZap);
- timestamp: Data e horário da criação do lead no formato ISO_LOCAL_DATE_TIME;
- originLeadId: Identificador do lead do GrupoZap;
- originListingId: Identificador do anúncio do GrupoZap;
- clientListingId: Identificador do anúncio para o anunciante (ListingId);
- name: Nome do consumidor que gerou o lead;
- email: E-Mail do consumidor que gerou o lead;
- ddd: DDD do telefone do consumidor que gerou o lead Ex:
11; - phone: Telefone do consumidor que gerou o lead Ex:
999999999; - phoneNumber: [deprecado] Telefone do consumidor que gerou o lead (DDD + Phone) Ex:
11999999999; - message: Mensagem do consumidor que gerou o lead;
O campo clientListingId é único identificador do anúncio/empreendimento conhecido pelo Software/CRM e GrupoZap, este identificador chega até nós via carga Feeds como codigo da listing (ListingId) ou customizado diretamente nos Software/CRM pelo cliente. Considere este identificador para realizar a devida associação do lead com o anúncio/empreendimento do cliente. Caso este identificador não estiver contído na requisição, deverá retornar o statusCode da família 400 (4xx) para ser analisado e reprocessado futuramente.
Quando um cliente deixa de usar um CRM que tem integração de leads ativa com o Grupo Zap, CRM poderá retornar StatusCode=404 na resposta da integração, desta forma, nosso sistema irá identificar integrações inexistentes e remover de nossos cadastros evitanto futuras requisições.
A requisição POST para o endpoint está configurada com timeout de 5 segundos, ou seja, qualquer requisição que demorar mais que 5 segundos será considerada ERRO sendo reenviadas de acordo com nossas regras de retentativas.
Para verificar a confiabilidade do emissor das requisições, será enviado no Header uma chave de segurança no padrão Basic Authentication. A chave a ser verificada será no seguinte formato:
Exemplo:
Authorization: Basic ***REMOVED***
Para saber mais sobre como implementar a segurança acesse a wiki.
Assim que as implementações forem realizadas, envie as seguintes informações para o e-mail abaixo:
- Enpoint implementado
- Nome do CRM Integrador
clientListingIdque será utilizado na homologação- E-mail para cadastro e envio dos erros da integração de leads
Após homologação da Integração de Leads e todo processo estiver finalizado, enviar todos os clientes em um arquivo CSV contendo os seguintes campos: DOCUMENT,URL,SEND_LEAD_EMAIL
- DOCUMENT: CPF ou CNPJ do cliente sem máscara/formatação [text];
- URL: Url de integração do cliente [text];
- SEND_LEAD_EMAIL: Flag para configurar se o lead também será enviado por e-mail [boolean];
DOCUMENT,URL,SEND_LEAD_EMAIL
56921485000100,https://crm.com.br/lead,false
Enviar em anexo o arquivo csv para o e-mail:
Caso tenha alguma dúvida, sugestão ou problemas durante a implementação da integração de Leads, abra um Issue neste repositório que iremos responder assim que possível.