| Produto | Linx DMS |
|---|---|
| Menu | - |
| Data |
|
| Autor | |
| Área | Linx DMS |
Este documento tem como finalidade documentar a utilização da API com a funcionalidade de integração de leads de veículos.
Esta funcionalidade pode ser utilizada por qualquer parceiro da Linx que possua um acordo para a utilização desta API, juntamente com os clientes.
Ambiente
Verifique o endereço do ambiente a ser utilizado na documentação Barramento.
Autenticação
O tipo de autenticação utilizada por este endPoint é a Autenticação V1.
A Integração de Leads de Veículos permite a criação de um contato que será gerenciado como um lead de veículo no Gestão Showroom/Fluxo de atendimento. Para a utilização desta funcionalidade da API é necessário que seja parametrizado algumas informações no Linx DMS .
Parametrização
Para utilizar a integração é necessário parametrizar algumas informações que serão utilizadas na criação do contato.
- Acessar o menu "CRM Plus > Parâmetros > Módulo, aba Geral > Integração Terceiros".
- Selecionar a "Origem de Tráfego do Contato", "Departamento do Contato", "Tipo do Contato", "Subtipo do Contato", "Forma de Contato" e "Usuário" que serão utilizados para criar o contato no momento da integração do lead.
Exemplo de consumo da API
Abaixo segue um exemplo de como consumir a API utilizando o ambiente desejado e o token de autenticação:
| Endereço de exemplo | http://apolloapp01.brazilsouth.cloudapp.azure.com:5001/LinxDMSAPI/ Parcerias/NovoLeadContato | ||||
|---|---|---|---|---|---|
| Método | POST | ||||
| Header |
|
Integração
Abaixo segue a documentação do endPoint disponibilizado para que o parceiro realize a integração dos leads de veículo.
| Rota | /Parcerias/NovoLeadContato |
|---|---|
| Método | POST |
| Descrição | Gera um novo contato representando um lead de veículo que será gerenciado através do Gestão Showroom/Fluxo de atendimento. |
| Observação | As propriedades Empresa e Revenda do Request, quando estes forem enviados como 0 ou não forem enviados, será obrigatória a propriedade CNPJRevenda. Também são obrigatórias as propriedades NomeCliente, CPF e CNPJ. Quando o CPF for null e o CNPJ não, será obrigatório o valor da propriedade InscricaoEstadual. Caso não seja enviada a FormaContato, será considerada a descrição da forma de contato parametrizada no sistema DMS. Ao receber a requisição, será buscado o cliente de acordo com CPF, caso ele não seja null. Se for, fará a busca pelo CNPJ. Ao encontrar o cliente, o cadastro será atualizado de acordo com as informações enviadas. Caso não queira atualizar o valor de determina propriedade, deverá enviar o valor como null ou não enviar a propriedade. Caso não seja localizado o cliente, será inserido um novo. Após integrar o cliente, será criado um contato de acordo com a parametrização do módulo CRM Plus com a seguinte descrição: Loja: Modelos da concorrência: Veículo usado como pagamento: Modelo do veículo usado: Valor do veículo usado: Pretende financiar: Data do Test Drive: Forma de Contato: |
| Request | { "Empresa": 0, "Revenda": 0, "CNPJRevenda": "string", "NomeCliente": "string", "CPF": "string", "CNPJ": "string", "InscricaoEstadual": "string", "DataNascimento": "2021-02-16T17:51:28.549Z", "DddTelefone": 0, "Telefone": 0, "DddCelular": 0, "Celular": 0, "Email": "string", "ModelosConcorrencia": "string", "UsadoComoPagamento": true, "DescricaoModeloUsado": "string", "ValorUsado": 0, "PretendeFinanciar": true, "DataHoraTestDrive": "2021-02-16T17:51:28.549Z", "FormaContato": "string", "TelefoneAdicional":"string" }
|
| Response |
Gestão de leads
Após ocorrer a integração, é possível realizar a gestão dos leads através do "Gestão de Showroom/Fluxo de Atendimento".
- Acessar a aba "Acompanhamento > Gestão de Leads" e localizar o contato integrado. A partir deste momento o contato poderá ser distribuído para o vendedor desejado.
