Inclusão de Leads

A API de Inclusão de novos leads consiste na possibilidade de uma aplicação com os dados de autenticação de uma loja, transferir os leads gerados em outras plataformas (ex: sites institucionais) para o CRM Webmotors.

Com a inclusão desses leads no CRM Webmotors, o cliente poderá realizar toda a gestão da negociação, leads e vendas pela própria plataforma, facilitando assim o dia a dia do cliente.

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
Caso ainda não tenha sua conta, acesse a página Cadastre-se e faça seu registro.
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 INSERÇÃO DE 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 Inclusão 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 da plataforma:
  • • Razão Social:
  • • CNPJ:
  • • Site:
  • • Nome da APP do Portal do Desenvolvedor:
  • • Cite o CNPJ de clientes em comum com a Webmotors:
  • • Regiões de atuação da plataforma:

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.
Somente após a homologação aprovada, a aplicação estará disponível para integração aos clientes em ambiente produtivo.
Obter os tipos de leads
Para incluir um novo lead no CRM pela API de Inclusão de Leads, você deve enviar um número de identificação de tipo.

Os tipos variam entre:
  • Proposta;
  • PropostaZeroKM;
  • Lead Site;
  • Outros
Obter os canais de leads
Para incluir um novo lead no CRM pela API de Inclusão de Leads, você deve enviar um número de identificação de canal de origem.

Canais aptos para recebimento: Sites Institucionais
Enviar um novo lead
Após obter o tipo de lead e o canal de origem que o lead foi inserido, você pode realizar o envio de um novo lead pela API de inclusão. Cada novo registro deve-se compor em 3 dados necessários: cliente, lead e anúncio.

Cliente: São dados referentes ao consumidor interessado no veículo. Ex: Nome, Email, Telefone.
Anúncio: São dados referentes ao veículo. Ex: Marca, Modelo, Versão, Ano Modelo, etc.
Lead: São dados referentes a mensagem, tipo e canal do lead. Ex: Canal de origem, Mensagem do lead, Tipo do lead, etc.
Exemplo requisição
O envio de lead divide-se em 3 dados necessários para a composição:
	{
	  "cliente": {
	    "nome": "string",
	    "email": "string",
	    "telefone": "string",
	    "cpf": "string",
	    "data_nascimento": "string",
	    "estado": "string",
	    "cidade": "string"
	  },
	  "lead": {
	    "id": 0,
	    "id_canal": 0,
	    "tipo_lead": 0,
	    "mensagem": "string",
	    "data": "string"
	  },
	  "anuncio": {
	    "tipo_anuncio": 0,
	    "marca": "string",
	    "modelo": "string",
	    "versao": "string",
	    "estilo": "string",
	    "placa": "string",
	    "ano_fabricacao": 0,
	    "ano_modelo": 0,
	    "preco": "string",
	    "km": 0,
	    "cor": "string"
	  }
	}

OBS: Os leads inseridos pela API de Inclusão não são possíveis de consulta pela API. Os leads retornados pela API de leads são apenas os do Grupo Webmotors e não de quaisquer outros canais (ex: sites institucionais).
Veja mais exemplos
Baixe a Collection do Postman clicando aqui.
Produção
Após a validação do desenvolvedor, o próprio lojista deverá criar o usuário com perfil de “Integrador de API” dentro do Cockpit CRM, lembrando que cada loja pode possuir apenas um usuário de Integração de API. Veja em nosso FAQ o passo-a-passo de como criar o usuário de Integrador de API.

O Lojista deverá repassar o usuário e senha criados no CRM para o desenvolvedor. Com estas informações, o desenvolvedor realizará as configurações necessárias e o lojista terá a sua integração ativada, conforme finalidade da mesma.
Principais Erros

a) 401 - Unauthorized

Causa provável:

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

    A autenticação nas APIs de Inclusão 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.

b) Lead não disponível no CRM WebMotors

Causa provável:

  • Autenticação realizada com usuário INTEGRADOR DE API incorreto, para este caso, deve ser revisto os dados de acesso do usuário.