{"info":{"_postman_id":"956ed2f6-25e9-448c-ac4f-13b27f85ff8a","name":"Gobrax API - Odômetro","description":"

Autenticação

A verificação de segurança é feita em toda requisição através do token de API (API Key).

O token deve estar presente em todas as requisições.

O 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.

A 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
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJHb2JyYXgiOjF9.KpILLSFkfb2WvCWcCV_YYxzYZ-qGPYfbZ504aSGlSE8
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27100945","collectionId":"956ed2f6-25e9-448c-ac4f-13b27f85ff8a","publishedId":"2s93sf2BRK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-13T20:09:29.000Z"},"item":[{"name":"Vehicles Odometer","id":"cc56843b-1f7e-4151-b622-ddb80a4e10e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://gateway-v3.gobrax.com.br:8889/api/v2/vehicle-odometer?startDate=2021-02-10 00:00:00&endDate=2021-02-10 23:59:59&vehicleIdentification=","description":"

Sobre

API responsável por apresentar a informação de odômetro do veículo. Inserindo uma data inicial e uma data final, a API retornará o último odômetro coletado para o veículo dentro daquele período indicado.

As informações disponíveis no retorno das requisições serão:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
vehicleIdentification	string	(obrigatório) Identificação do veículo em nosso banco de dados, sempre cadastrado com a PLACA do mesmo. Exemplo: ABC1234
startDate	string	(obrigatório) data inicial indicada para a análise, expressada no formato: YYYY-MM-DD HH:MM:SS A data deve ser expressada em UTC
endDate	string	(obrigatório) data final indicada para a análise, expressada no formato: YYYY-MM-DD HH:MM:SS A data deve ser expressada em UTC
odometer	float	Indicará o último odômetro coletado dentro do período indicado nos campos acima. O odômetro será expressado em quilômetros (KM)
lastUpdated	string	Indicará a data e hora exata que o odômetro foi coletado, expressada no formato: YYYY-MM-DD HH:MM:SS.

Limites e Restrições

Limite de Requisições

O 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.

Período de consulta

O período máximo de pesquisas permitidas é de 31 dias, ou seja, o intervalo entre startDate e endDate não poderá ser maior que o determinado. Caso seja necessário consultar períodos maiores faça o particionamento da consulta em janelas de 31 em 31 dias.

\n","urlObject":{"protocol":"https","port":"8889","path":["api","v2","vehicle-odometer"],"host":["gateway-v3","gobrax","com","br"],"query":[{"description":{"content":"

(obrigatório): O campo deve ser preenchido com a data e hora inicial da análise. A data deve ser expressada no padrão UTC. No formato: YYYY-MM-DD HH:MM:SS

\n","type":"text/plain"},"key":"startDate","value":"2021-02-10 00:00:00"},{"description":{"content":"

(obrigatório): O campo deve ser preenchido com a data e hora final da análise. A data deve ser expressada no padrão UTC: No formato: YYYY-MM-DD HH:MM:SS

\n","type":"text/plain"},"key":"endDate","value":"2021-02-10 23:59:59"},{"description":{"content":"

(obrigatório): O campo deve ser preenchido com a PLACA do veículo. A placa deve ser inserida sem espaços ou caracteres especiais de separação, como hífens ou barras. Ex: ABC1234

\n","type":"text/plain"},"key":"vehicleIdentification","value":""}],"variable":[]}},"response":[{"id":"9d229897-f65d-4484-845c-303f7bfdf751","name":"OK - Vehicle Statistics successfully retrieved for all vehicles","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v2/vehicle-odometer?startDate=2021-12-12 00:00:00&endDate=2021-12-12 15:00:00","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v2","vehicle-odometer"],"query":[{"key":"startDate","value":"2021-12-12 00:00:00"},{"key":"endDate","value":"2021-12-12 15:00:00"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"records\": [\n {\n \"vehicleIdentification\": \"ABC-1234\",\n \"startDate\": \"2021-12-12 00:00:00\",\n \"endDate\": \"2021-12-12 15:00:00\",\n \"odometer\": 291862.215,\n \"lastUpdated\": \"2024-03-06 02:52:19+0000\"\n },\n {\n \"vehicleIdentification\": \"DDD-4444\",\n \"startDate\": \"2021-12-12 00:00:00\",\n \"endDate\": \"2021-12-12 15:00:00\",\n \"odometer\": 311202.110,\n \"lastUpdated\": \"2024-03-06 02:52:19+0000\"\n }\n ]\n}"},{"id":"d01d441d-4bc4-4816-9759-87945a9fa24c","name":"OK - Vehicle Statistics successfully retrieved for a specific vehicle","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v2/vehicle-odometer?startDate=2021-12-12 00:00:00&endDate=2021-12-12 15:00:00&vehicleIdentification=ABC-1234","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v2","vehicle-odometer"],"query":[{"key":"startDate","value":"2021-12-12 00:00:00"},{"key":"endDate","value":"2021-12-12 15:00:00"},{"key":"vehicleIdentification","value":"ABC-1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"records\": [\n {\n \"vehicleIdentification\": \"ABC-1234\",\n \"startDate\": \"2021-12-12 00:00:00\",\n \"endDate\": \"2021-12-12 15:00:00\",\n \"odometer\": 291862.215\n \"lastUpdated\": \"2024-03-06 02:52:19+0000\"\n }\n ]\n}"},{"id":"ac234950-f235-4b0c-ad03-e550377bab65","name":"Bad Request - Failed to get Vehicle statistics due missing vehicle","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?startDate=2021-12-10 00:00:00&endDate=2021-12-10 20:00:00&vehicleIdentification=NONE-1","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v1","vehicle-statistics"],"query":[{"key":"startDate","value":"2021-12-10 00:00:00"},{"key":"endDate","value":"2021-12-10 20:00:00"},{"key":"vehicleIdentification","value":"NONE-1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"400-1\",\n \"errorDescription\": \"Vehicle not found\"\n}"},{"id":"cdedf1f9-4797-4ada-ae19-90ff62897be5","name":"Bad Request - Failed to get Vehicle statistics due missing start date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?endDate=2021-12-15 12:00:00","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v1","vehicle-statistics"],"query":[{"key":"endDate","value":"2021-12-15 12:00:00"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"400-2\",\n \"errorDescription\": \"Start Date not provided\"\n}"},{"id":"2769f6e8-8d82-438f-90e0-bd7bf5b8e1ca","name":"Bad Request - Failed to get Vehicle statistics due missing end date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?startDate=2021-12-15 12:00:00","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v1","vehicle-statistics"],"query":[{"key":"startDate","value":"2021-12-15 12:00:00"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"400-3\",\n \"errorDescription\": \"End Date not provided\"\n}"}],"_postman_id":"cc56843b-1f7e-4151-b622-ddb80a4e10e4"}]}