{"info":{"_postman_id":"d9d4fbb4-748f-4d03-8940-4cc2988c7ef0","name":"Gobrax API - Posições","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
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJHb2JyYXgiOjF9.KpILLSFkfb2WvCWcCV_YYxzYZ-qGPYfbZ504aSGlSE8
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17914053","collectionId":"d9d4fbb4-748f-4d03-8940-4cc2988c7ef0","publishedId":"2s847ESZus","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-10-17T20:46:46.000Z"},"item":[{"name":"Vehicles Positions","id":"e5bfd145-acad-4544-9c49-519c13fee782","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-last-position?startDate=2021-02-10 00:00:00&endDate=2021-02-10 23:59:59&vehicleIdentification=","description":"

Sobre:

API responsável por fornecer as informações de geolocalização dos veículos através da latitude e da longitude. Inserindo a data inicial e final para a análise, você terá acesso a última localização coletada do veículo naquele período. Por exemplo, se você fizer uma requisição com data inicial “2024-10-11 00:00:00” e data final (endDate) “2024-10-11 23:59:59” a API retornará a última localização coletada nesse intervalo de tempo.

Por padrão, nosso equipamento comunica a localização de 30 em 30 segundos (salvo algumas exceções), ou seja, a cada 30 segundos o veículo nos comunica uma nova localização e ela fica disponível através da API para coleta.

Observações:

Áreas de sombra: As áreas de sombra são regiões sem cobertura por antenas de comunicação. Ao passar por uma delas, a transmissão da localização do veículo será comprometida até que o veículo saia dela. Durante o período nesta região, nossos dispositivos continuam coletando informações e quando a comunicação é restabelecida fazem o envio do histórico.

The following data is available for every record:

\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) Deve receber a PLACA do veículo cadastrada em nosso banco de dados. A placa deve conter apenas letras e números sem a necessidade de caracteres de separação (como hífens ou barras). Exemplo: ABC1234 IMPORTANTE: Se o campo placa ficar sem preenchimento, a API retornará erro. A API permite 1 veículo por requisição.
startDate	string	(obrigatório) startDate → (obrigatório) Deve receber a data e hora inicial da análise, ela deve ser expressada no método UTC seguindo o padrão: YYYY-MM-DD HH:MM:SS IMPORTANTE: Se os campos de datas não respeitarem o padrão determinado, a API retornará erro.
endDate	string	(obrigatório) Deve receber a data e hora final da análise, ela deve ser expressada no método UTC seguindo o padrão: YYYY-MM-DD HH:MM:SS IMPORTANTE: Se os campos de datas não respeitarem o padrão determinado, a API retornará erro.
lastPosition	object	Objeto contendo as informações de posição do veículo

Posição

O objeto representa os dados de latitude e longitude do veículo, e a requisição sempre vai trazer os seguintes dados:

\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
date	string	Data e hora em que a posição foi coletada
lat	float	Latitude da coordenada
percentage	float	Longitude da coordenada.

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.

\n","urlObject":{"protocol":"http","port":"8888","path":["api","v1","vehicle-last-position"],"host":["gateway-v3","gobrax","com","br"],"query":[{"description":{"content":"

(obrigatório) Deve receber a data e hora inicial da análise, ela deve ser expressada no método UTC seguindo o padrão: YYYY-MM-DD HH:MM:SS.

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

(obrigatório) Deve receber a data e hora final da análise, ela deve ser expressada no método UTC seguindo o padrão: YYYY-MM-DD HH:MM:SS

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

(obrigatório) Deve receber a PLACA do veículo cadastrada em nosso banco de dados. A placa deve conter apenas letras e números sem a necessidade de caracteres de separação (como hífens ou barras).

\n","type":"text/plain"},"key":"vehicleIdentification","value":""}],"variable":[]}},"response":[{"id":"8b9788fe-11dd-4c73-98d3-226b12b4f735","name":"OK - Vehicle Last Position successfully retrieved for all vehicles","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-last-position?startDate=2021-12-12 00:00:00&endDate=2021-12-12 15:00:00","protocol":"http","host":["gateway-v3","gobrax","com","br"],"port":"8888","path":["api","v1","vehicle-last-position"],"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\t\"records\": [\n {\n \"vehicleIdentification\": \"ABC-1234\",\n \"startDate\": \"2021-12-12 00:00:00\",\n \"endDate\": \"2021-12-12 15:00:00\",\n \"lastPosition\": {\n \"date\": \"2021-12-12 14:45:00\",\n \"lat\": -25.441105,\n \"lon\": -49.276855,\n },\n },\n {\n \"vehicleIdentification\": \"DDD-4444\",\n \"startDate\": \"2021-12-12 00:00:00\",\n \"endDate\": \"2021-12-12 15:00:00\",\n \"lastPosition\": {\n \"date\": \"2021-12-12 14:48:33\",\n \"lat\": -16.4713,\n \"lon\": -54.6371,\n },\n },\n \n ]\n}"},{"id":"6df77d8d-4575-43d1-a3ca-3eacf34741b7","name":"OK - Vehicle Last Position successfully retrieved for a specific vehicle","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-last-position?startDate=2021-12-12 00:00:00&endDate=2021-12-12 15:00:00&vehicleIdentification=ABC-1234","protocol":"http","host":["gateway-v3","gobrax","com","br"],"port":"8888","path":["api","v1","vehicle-last-position"],"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 \"lastPosition\": {\n \"date\": \"2021-12-12 14:45:00\",\n \"lat\": -25.441105,\n \"lon\": -49.276855,\n },\n }\n ]\n}"},{"id":"c0dd0dc4-d47e-4925-a878-f39822f4e64b","name":"Bad Request - Failed to get Vehicle Last Position due missing vehicle","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-last-position?startDate=2021-12-10 00:00:00&endDate=2021-12-10 20:00:00&vehicleIdentification=NONE-1","protocol":"http","host":["gateway-v3","gobrax","com","br"],"port":"8888","path":["api","v1","vehicle-last-position"],"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":"e932a3db-a495-4172-bf25-24551ee2c25b","name":"Bad Request - Failed to get Vehicle Last Position due missing start date","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-last-position?endDate=2021-12-15 12:00:00","protocol":"http","host":["gateway-v3","gobrax","com","br"],"port":"8888","path":["api","v1","vehicle-last-position"],"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":"43ca409b-1f6d-41ed-829a-03f256acddd9","name":"Bad Request - Failed to get Vehicle Last Position due missing end date","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-last-position?startDate=2021-12-15 12:00:00","protocol":"http","host":["gateway-v3","gobrax","com","br"],"port":"8888","path":["api","v1","vehicle-last-position"],"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":"e5bfd145-acad-4544-9c49-519c13fee782"}]}