Manual de Integração com a API de Leads da Usadosbr/Moto.com.br
Processo
A busca de leads através da API tem duas partes: autenticação e a busca propriamente dita. A autenticação é via token JWT, que é um método RCT 7519 padrão da indústria para realizar autenticação entre duas partes por meio de um token assinado que autentica uma requisição web.
Autenticação
Para a Autenticação, será preciso enviar uma requisição HTTP ao endpoint de autenticação da API. Nela é enviado, no corpo da requisição, o “user” e o “password”, disponibilizados. Dessa maneira:
| Endpoint | Descrição |
|---|---|
| https://api.usadosbr.com/leads/token | Endpoint de Produção |
| https://api.usadosbr.dev/api/leads/token | Endpoint de Homologação |
Uma vez que os dados enviados pelo cliente tenham sido autenticados, a API retornará um token que será utilizado para o endpoint de busca de Leads, dessa forma:
Requisição
Com o token, realizar o consumo da API como segue:
| Descrição | Valor |
|---|---|
| Método HTTP | GET |
| Endpoint de Produção | https://api.usadosbr.com/leads/ |
| Endpoint de Homologação | https://api.usadosbr.dev/api/leads/ |
| Authorization | Bearer + Token gerado pela autenticação |
A API retornará todos os leads recebidos dos anunciantes vinculados, desde a última requisição. Caso seja a primeira, trará todos os Leads recebidos nos últimos cinco minutos.
Header
| Chave | Valor |
|---|---|
| Authorization | Bearer «token recebido no procedimento anterior» |
Query Params
Caso queira filtrar por data, pode-se passar as datas por query params, no formato Y-m-d H:i:s. Também é possível definir o limite de leads enviadas (padrão 100).
| Chave | Valor | Descrição |
|---|---|---|
| start | 2024-08-01 00:00:00 | Data início |
| end | 2024-08-30 23:59:00 | Data fim |
O consumo da API ficará da seguinte forma:
| Descrição | Valor |
|---|---|
| Método HTTP | GET |
| Endpoint de Produção | https://api.usadosbr.com/leads/?start=2024-08-09 00:01:00&end=2024-08-09 23:59:59 |
| Endpoint de Homologação | https://api.usadosbr.dev/api/leads/?start=2024-08-09 00:01:00&end=2024-08-09 23:59:59 |
| Authorization | Bearer + Token gerado pela autenticação |
Resposta da Requisição
Erros:
Tabela de Status de Erros
| Status | Descrição |
|---|---|
| 429 | Mais de uma requisição em menos de cinco minutos |
| 422 | Data inválida (start ou end) |
Informações Complementares
Solicitação de acesso aos leads da loja, enviar no Fale Conosco.
A identificação a que loja o lead se refere deve ser realizada pelo CNPJ enviado junto do lead.
Segue nossa documentação completa:
