Integração via API – Mr. Sales
Primeiros Passos:
1. Solicitar Token de Acesso:
Caso ainda não tenha o token de acesso à API, solicite-o através do nosso Fale Conosco.
2. Ferramentas de Teste e Conhecimento Técnico:
Utilize um software para testes de API REST ou tenha conhecimento técnico em alguma linguagem de programação. Softwares recomendados:
• Postman
• Insomnia
Informações Importantes:
1. É necessário ter conhecimento sobre o protocolo HTTP e chamadas REST para entender a documentação.
2. Tenha os tokens de Homologação e Produção.
O ambiente de homologação não possui as mesmas informações de produção é um playground para testes e aprendizado da API.
3. Realize todos os testes no ambiente de homologação para evitar dados incorretos no ambiente de produção.
4. O desenvolvimento e testes devem ser realizados pela empresa que deseja integrar com o Mr. Sales. O suporte técnico do Mr. Sales não abrange dúvidas de código ou implementação além do que está documentado, salvo ponto do documento que necessitam de atualização.
Exemplos de Funcionalidades na API:
1. Consulta de Bandeiras
A consulta de bandeira retorna as marcas atribuídas as lojas cadastradas no sistema.
• Produção: https://api.mrsales.com.br/parceiro/bandeiras
• Homologação: https://api-homolog.mrsales.com.br/parceiro/bandeiras
Caso não retorne uma marca desejada deve solicitar para o administrador da loja a associação da Bandeira as lojas cadastradas no Mr. Sales
2. Consulta de Lojas
A consulta de lojas retorna todos os cadastros vinculados ao token disponibilizado para cada ambiente.
• Produção: https://api.mrsales.com.br/parceiro/lojas
• Homologação: https://api-homolog.mrsales.com.br/parceiro/lojas
Exemplos de filtros:
• https://api.mrsales.com.br/parceiro/lojas?BandeiraID=CÓDIGO
• https://api.mrsales.com.br/parceiro/lojas?marca=HYUNDAI&modelo=HB20
• https://api.mrsales.com.br/parceiro/lojas?observação=Oficina
• https://api.mrsales.com.br/parceiro/lojas?cidade=Osasco&estado=SP
Caso alguma informação não esteja preenchida deve solicitar para o administrador da loja preencher no cadastro.
3. Consulta de Catálogo 0KM:
O catalogo 0KM retornar os veículos disponível na unidade ”Loja” afim de padronizar os cadastros de lead 0KM
• Produção: https://api.mrsales.com.br/parceiro/catalogo/LOJA_ID
• Homologação: https://api-homolog.mrsales.com.br/parceiro/catalogo/LOJA_ID
Campos obrigatórios:
• LojaID (retornado na consulta de lojas).
4. Cadastrar Lead:
Permite cadastrar um novo lead na loja.
Os campos vazio (NULL) não são obrigatórios, mas caso seja exigência do cliente deve ser preenchido para sair no cadastro e relatórios.
• Produção: https://api.mrsales.com.br/parceiro/lead
• Homologação: https://api-homolog.mrsales.com.br/parceiro/lead
Campos obrigatórios:
• LojaID (retornado na consulta de lojas).
• Necessário informar o Token de acesso, como nos exemplos anteriores.
• Opcional: Preencher LojaCatalogoID conforme a necessidade.
Estrutura JSON disponível em: https://github.com/MrSales/parceiros-api/blob/master/README.md#cadastrar-lead
Caso o cliente deseje customizar a Mídia padrão “Site” será necessário a solicitação do código no Fale Conosco.
5. Consultar Leads Cadastrados:
Retorna os últimos 100 leads cadastrados via API ou outras fontes.
• Produção: https://api.mrsales.com.br/parceiro/leads/LOJA_ID
• Homolog: https://api-homolog.mrsales.com.br/parceiro/leads/LOJA_ID
Campos obrigatórios:
• LojaID (retornado na consulta de lojas).
Caso alguma informação não esteja preenchida necessário verificar o método de cadastrar lead.
