Integração com Construtor de Vendas (CV)
Esta documentação técnica descreve os passos necessários para integrar o sistema de CRM com o Construtor de Vendas (CV), permitindo o envio de leads para a plataforma CV.
Pré-requisito
1. Ligar desenvolvimento
Antes de iniciar a configuração da integração, é necessário garantir que a getDesvOc 182647 esteja ativada no sistema.
2. Configurar status
É necessário configurar os status de RESERVA e REPASSE com os seguintes códigos para que os respectivos webhooks consigam fazer a movimentação das ocorrências quando os pré-cadastros forem alterados no CV.
- Status de RESERVA: LEAD_RESERVA
- Status de REPASSE: LEAD_REPASSE
3. Configuração dos Webhooks
É necessário configurar os webhooks no CV para que o CRM seja capaz de receber as atualizações dos pré-cadastros e atualizar as respectivas ocorrências. Para isso, acesse o configurador de webhook no portal do CV acessando: Configurações > Integrações > Webhooks > Configurar
Abaixo, temos a lista dos endpoints que devem ser configurados:
| URL | Funcionalidade |
|---|---|
| CAMINHO_SISTEMA/webservices/webhooks/cv/pre-cadastro.php | Pré-cadastro |
| CAMINHO_SISTEMA/webservices/webhooks/cv/reserva.php | Reserva |
| CAMINHO_SISTEMA/webservices/webhooks/cv/repasse.php | Repasse |
Configuração da Integração
1. Acessar a tela de parametrização da integração
A configuração da integração com o CV deve ser realizada acessando o menu: Pré-vendas > Parametrizações > Integração com Construtor de Vendas
2. Informar os dados da API do CV
Nesta tela, será necessário fornecer os seguintes dados:
- Endpoint da API do CV
- Token
- E-mail fornecidos pela plataforma CV
Essas informações são obrigatórias para que o sistema possa se comunicar corretamente com o CV.
3. Configurar o status para envio de leads
Depois de configurar a integração, é necessário definir um status no sistema que será responsável por salvar os dados do lead e enviar para o CV. Esse status deve ser configurado com a integração externa chamada “Pré-Cadastro com Construtor de Vendas”.
Ao configurar essa integração externa, o campo IDOCORRENCIA será preenchido automaticamente e deverá conter o número da ocorrência relacionada ao lead. Essa é a única informação necessário nessa integração externa, pois a partir do IDOCORRENCIA, conseguimos pegar os demais campos.
OBS: Qualquer outro campo que for configurado nessa integração externa será ignorado.
4. Validação dos dados do lead
Ao movimentar uma ocorrência para o status configurado, o sistema fará uma verificação para garantir que todos os dados obrigatórios do lead estão preenchidos corretamente.
Caso algum campo esteja ausente ou incorreto, o sistema informará através de uma mensagem na tela do operador e por uma narrativa na ocorrência, especificando os campos que precisam ser corrigidos.
Se todos os campos estiverem corretos, o lead será enviado ao CV. Após, será exibido uma mensagem na tela do operador informando se o pré-cadstro aconteceu com sucesso ou não e os respectivos motivos. Esse retorno também constará na narrativa.
Envio dos Leads
1. Execução da Integração Externa
Uma vez que a ocorrência foi movimentada para o status configurado com a integração externa, o lead da ocorrência será enviado para o CV.
Após o envio do lead para o CV, será gerada uma narrativa na ocorrência informando o resultado do envio. Isso inclui tanto mensagens de sucesso quanto de erro. Também será apresentado uma mensagem na tela do operador com a informação do sucesso ou erro.
2. Forçar envio dos dados via ocorrência
É possível forçar o envio dos dados do lead para o CV através de um botão existente na tela de atendimento do lead. Esse botão irá exibir a data do último envio do lead (se tiver).
Ao utiliza-lo, o sistema enviar diretamente o lead e ao CV e informará o resultado desse envio nas narrativas do sistema.
Associados
O sistema permite adicionar apenas 1 associado por pré-cadastro, conforme limitação imposta pelo CV. É possível buscar ou criar associados.
OBS: Um associado é basicamente um novo cliente vinculado ao pré-cadastro.
Regras obrigatórias para associados
Ao buscar ou inserir associados, é obrigatório o preenchimento do campo Tipo de Associado (fiador, testemunha, cônjuge, etc).
Caso esteja faltando algum dado do associado, será informado na narrativa quando o pré-cadastro for enviado ao CV.
Envio de Documentos
Para enviar documentos ao CV, é necessário criar um campo adicional no CRM. O campo deve ser do tipo “Upload de Arquivo” e ter o código “ARQUIVO_CV”.
Limitações no envio de anexos
Durante o desenvolvimento da integração, foi mapeado o envio de apenas 1 anexo por pré-cadastro, mas essa limitação é uma restrição do CRM, não do CV.
No CV, é possível enviar mais de um anexo, mas isso requer que várias requisições sejam feitas em sequência para cada arquivo a ser enviado. Portanto, para enviar múltiplos anexos, deve-se implementar chamadas repetidas para o envio de documentos.
Envio do Valor da Avaliação
Para enviar o valor da avaliação de um lead, é necessário criar um campo adicional no CRM. O campo deve ser do tipo “Valor Monetário” e ter o código “VALOR_AVALIACAO”.
Auditoria de Envio
É possível acompanhar os envios dos leads ao CV através do caminho CRM > Integração de Dados > Auditorias > Construtor de Vendas (Recebimento). Lá será possivel acompanhar informações sobre o envio como o retorno do CV, o dados que foram enviados, quando foram enviados, etc.