A verificação de segurança é feita em toda requisição através do token de API (API Key).
\nO token deve estar presente em todas as requisições.
\nO token será fornecido pela Gobrax após a assinatura de contrato de uso da API, mande um email para suporte@gobrax.com.br seja para criação de uma nova chave ou atualização da chave vigente.
\nA chave de segurança deve estar presente no header (cabeçalho) das requisições e seguir o padrão, como no exemplo abaixo sem as aspas ou espaços antes ou depois**:**
\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27100945","collectionId":"01e8e484-ca95-42e5-8612-03feeaeb297e","publishedId":"2s9Ye8hvPt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-11-20T17:43:40.000Z"},"item":[{"name":"Public Score Api","id":"929b9e7f-a8b6-4990-98d5-de2b6490bb61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJHb2JyYXgiOjF9.KpILLSFkfb2WvCWcCV_YYxzYZ-qGPYfbZ504aSGlSE8
\n
API responsável por apresentar os dados gerais de performance por mês dos motoristas.
\nAs informações apresentadas serão as mesmas exibidas na tela inicial da plataforma web Gobrax.
\nParâmetros para requisição
\nOs dados disponibilizados serão:
\nOverview
\nObjeto que trará as informações de premiação do motorista, contendo as seguintes informações:
\nO volume máximo de requisições permitidas é de 10/segundo. As requisições que excederem esse número serão bloqueadas pela API, o serviço irá normalizar assim que o volume retornar ao padrão determinado.
\n","urlObject":{"protocol":"https","port":"8889","path":["api","v2","driversOverview"],"host":["gateway-v3","gobrax","com","br"],"query":[{"description":{"content":"(opcional) O campo deve ser preenchido com o CPF do motorista cadastrado em nosso banco de dados. Se o campo não for preenchido, o retorno trará os dados de todos os motoristas que possuem viagem ativa no mês indicado.
\n","type":"text/plain"},"key":"documentNumbers","value":""},{"description":{"content":"(obrigatório) Campo deve ser preenchido com o período inicial de análise. Os valores devem ser expressados no padrão: MM-AAAA, por exemplo: 05/2024.
\n","type":"text/plain"},"key":"startDate","value":"05-2024"},{"description":{"content":"(opcional) Campo deve ser preenchido com o período final de análise.Os valores devem ser expressados no padrão: MM-AAAA, por exemplo: 05/2024. \nSe o campo não for preenchido, a API retornará os dados de todos os meses desde o período indicado na data inicial. \nVamos imaginar que estamos no mês 10/2024, o startDate preenchido é 09/2024 e a requisição não possui endDate. A API retornará os dados do mês 09/2024 e do mês 10/2024.
\n","type":"text/plain"},"key":"endDate","value":"06-2024"}],"variable":[]}},"response":[{"id":"86ef19cb-5214-4ef2-9a72-582dcbbd6270","name":"OK - Vehicle Score successfully retrieved for all vehicles","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"your-key","type":"text"}],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v2/driversOverview?documentNumbers=&period=05-2023&periodEnd=","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v2","driversOverview"],"query":[{"key":"documentNumbers","value":""},{"key":"period","value":"05-2023"},{"key":"periodEnd","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"ID\": 13,\n \"Name\": \"RONALDO Gobrax\",\n \"DocumentNumber\": \"xxxxxxxxxxxx\",\n \"Err\": \"\",\n \"Overview\": [\n {\n \"Date\": \"05-2023\",\n \"Reward\": 0,\n \"TotalKM\": 0,\n \"Score\": 0,\n \"Err\": \"performance data not found\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"929b9e7f-a8b6-4990-98d5-de2b6490bb61"}]}