Consultar Leads Webmotors

A API de consulta de lead Webmotors consiste na possiblidade de um CRM terceiro ter acesso aos leads originados do Grupo Webmotors.

Através dessa API, o cliente que utiliza um CRM terceiro poderá realizar a gestão de leads da Webmotors na plataforma de sua preferência.

Obs. 1: Para utilização dessa API será necessária a autorização prévia da área de Produtos/Tecnologia.

Obs. 2: Qualquer dúvida ou problema será esclarecido através do canal de Suporte.

Registre-se no Portal de Desenvolvedores da Webmotors
É simples, faça seu registro de usuário na página Cadastre-se.
Crie a sua APP
Após ter se registrado no portal, registre seu aplicativo na área logada para obter seu Client ID e Client Secret no menu APPs, através do botão Cadastrar Nova APP.

Preencha os dados de sua APP e selecione a API: WEBMOTORS LEADS API 1.0.0
Solicite autorização para uso da API
Após a criação de sua APP, pedimos a gentileza de criar um chamado na seção Suporte solicitando a liberação da API de Consulta de Leads. Neste chamado, informe os seguintes dados:
 
  • • Nome do Solicitante:
  • • Contato do Solicitante (E-mail e telefone):
  • • Contato do canal de Suporte (E-mail e telefone):
  • • Nome do CRM:
  • • Razão Social:
  • • CNPJ:
  • • Site:
  • • Nome da APP do Portal do Desenvolvedor:
  • • Logo do CRM (em PNG):
  • • Cite o CNPJ de clientes em comum com a Webmotors:
  • • Regiões de atuação do CRM:

Obs: Todos os dados são obrigatórios para a solicitação da integração.

Assim que a análise for concluída, comunicaremos o resultado através do chamado aberto.
Homologação
Você receberá a liberação ou negação de uso no próprio chamado. Caso sua solicitação seja aprovada, enviaremos os dados de acesso para nosso ambiente de homologação.

Para mais informações sobre autenticação clique aqui.

Utilize a seguinte URL para acessar nosso ambiente de homologação:
https://hlg-webmotors.sensedia.com/oauth/v1/access-token

Os códigos de retorno são baseados nos códigos HTTP.

O horário de funcionamento do ambiente de homologação é de segunda à sexta, das 08hrs até 20hrs.

Somente após a homologação aprovada, a aplicação estará disponível para integração aos clientes em ambiente produtivo.

IMPORTANTE: Os acessos ao ambiente de testes/homologação da Webmotors serão revogados após 90 dias corridos ou quando a integração desenvolvida for aprovada e promovida para ambiente produtivo (o que ocorrer primeiro). O prazo para expiração dos acessos é calculado a partir da data de liberação das credenciais para testes.
Desenvolvimento da Aplicação
Após obter sua autenticação, acesse nossa documentação para iniciar o desenvolvimento:
https://portal-webmotors.sensedia.com/api-portal/swagger/webmotors-leads-api/1.0.0?r=2564#/

Com os dados acima você poderá utilizar todos os métodos disponíveis na API de consulta de leads Webmotors.
Notificação Callback
A API de Notificação Callback consiste na comunicação entre a API da Webmotors e a API do parceiro integrador de Leads.

Ao cadastrar a sua aplicação (APP), informe a URL para Notificação de Leads no campo "CALLBACK URL LEADS".

Através deste endereço, a Webmotors notificará todos os leads recebidos por clientes que ativaram a Integração com CRM Terceiro na aba de “Integrações” no Cockpit Estoque (https://www.cockpit.com.br/inventory/php/integracoes).

Para cada notificação recebida, o CRM Parceiro deverá retornar o código correspondente ao resultado da notificação:
 
  • • Sucesso - 200;
  • • Erro – Código do Erro.
Caso a API obtenha um status diferente do sucesso (HTTP 200), a mesma entrará em uma fila de retentativas. Cada retentativa será realizada no período de 4 horas até o recebimento do status HTTP 200.
 

Exemplo de requisição:

			{
				"IdLead": "424722",
				"CodigoCliente": "3823863",
				"Cnpj": "03347828000109",
				"IdTipoLead": "1"
			}
		
Com os dados acima você poderá utilizar a API de consulta de leads para recuperar os dados completos do lead.

Tipo Lead da Notificação (IdTipoLead):
 
  • • Proposta: 1
  • • PropostaSite: 2
  • • PhoneTracking: 4
Veja exemplos
Baixe a Collection do Postman clicando aqui.
Tipos de Leads
No endpoint de listagem de propostas, os valores possíveis para campo “tipoLead” são:
 
  • • PhoneTracking = 1
  • • Proposta = 2
  • • PropostaZeroKm = 3
  • • PropostaMoto = 4
Os valores válidos para o campo "statusLead" são:
 
  • • Nova proposta = 1
  • • Em negociação = 2
  • • Aguardando visita = 3
  • • Visita realizada = 4
  • • Venda realizada = 5
  • • Venda não realizada = 6
  • • Negociação recusada = 7
Ativação da integração no Cockpit (Produção)
Após concluir com sucesso a homologação, abra um novo chamado no canal de Suporte e solicite a liberação da API em ambiente de Produção. Para tanto, encaminhe as evidências de sucesso dos seguintes itens:
 
  • • Consulta de propostas;
  • • Aceite/Recusa do lead;
  • • Consulta detalhada do lead;
  • • Status final do lead.
Para consumir os dados de leads de um determinado cliente, é preciso realizar os seguintes passos:
 
  • • O cliente deverá enviar os dados de acesso do usuário Integrador de API. Veja em nosso FAQ o passo-a-passo de como criar o usuário de Integrador de API;

  • • Cada lojista, de forma individual, deve acessar a aba “Integrações” no Cockpit Estoque (https://www.cockpit.com.br/inventory/php/integracoes) para realizar a ativação da integração com o CRM.
Principais Erros

a) Aceite do Lead - Bad Request (HTTP 400)


 

Causa provável:

  • Pacote de Leads Fixos Vigente:

    Os lojistas clientes da Webmotors têm a opção de contratar planos que preveem o aceite automático de leads em até 48 horas. Para estes casos, não é necessário executar a ação de Aceite do Lead e os dados ficam automaticamente disponíveis para consulta detalhada do lead.

b) APP inválida


 

Causa provável:

  • Integração com CRM não ativada:

    Para que os CRMs Parceiros tenham acesso aos dados de Leads dos lojistas, é necessário que o mesmo ative a integração com o CRM desejado na aba INTEGRAÇÕES do Cockpit (https://www.cockpit.com.br/inventory/php/integracoes).

    Este é um passo obrigatório para atender a LGPD.

c) 401 - Unauthorized

Causa provável:

  • Usuário de Integração Inválido:

    A autenticação nas APIs de Consulta de Leads da Webmotors deve ser realizada com um Usuário “Integrador de API” cadastrado pelo lojista no Cockpit (https://www.cockpit.com.br/user/listing).

    Através desta opção também é possível alterar dados do cadastro e redefinir a senha.

    Ao acionar o Suporte Técnico Webmotors, certifique-se de que os dados informados (e-mail e senha) estão corretos.