{"info":{"_postman_id":"f1c929d0-7279-451c-8e80-a50674862c5a","name":"Gobrax API - Performances","description":"

Autenticação

\n

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

\n

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

\n

O token será fornecido pela Gobrax após a assinatura de contrato de uso da API, mande um email para suporte@gobrax.com.br tanto para criação quanto para manutenção do seu token.

\n

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

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":"f1c929d0-7279-451c-8e80-a50674862c5a","publishedId":"2s93eU4FLe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-02T23:16:03.000Z"},"item":[{"name":"Vehicles Performances","id":"3cf1e018-0780-44e8-a91c-cf7fa9f6bd2c","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/v1/vehicle-performance?startDate=2021-02-10 00:00:00&endDate=2021-02-10 23:59:59&vehicleIdentification=","description":"

Sobre

\n

Ela é responsável por fornecer os dados de performance dos veículos presentes em nosso sistema, mostrando também qual é o motorista que está vinculado àquele veículo durante o período selecionado. Através do método GET, você poderá solicitar os dados de um ou mais veículos da frota dentro de um período selecionado para obter a performance dos veículos.

\n

Inserindo uma data inicial e uma data final, você receberá os dados de todos os veículos da frota naquele período.

\n

Todos os retornos terão os dados descritos abaixo:

\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
FieldTypeDescription
vehicleIdentificationstring(opcional) Deve ser preenchido com a PLACA do veículo, o campo deve receber apenas letras e números, sem a necessidade de espaços ou caracteres de separação como hífens (-) ou barras (/).

Exemplo: ABC1234
startDatestring(obrigatório) Deve ser preenchido com o horário de início da análise, o formato das datas deve respeitar os seguintes padrões: YYYY-MM-DD HH:MM:SS

Exemplo: 2024-01-01 23:59:59

IMPORTANTE: Se o formato das datas não for respeitado, a API retornará um erro. A API também não aceitará requisições onde o endDate for anterior ao startDate.
endDatestring(obrigatório) Deve ser preenchido com o horário final da análise, a data deve ser expressada em UTC, seguindo o padrão: YYYY-MM-DD HH:MM:SS

Exemplo: 2024-01-01 23:59:59

IMPORTANTE: Se o formato das datas não for respeitado, a API retornará um erro. A API também não aceitará requisições onde o endDate for anterior ao startDate.
indicatorsobjectIndicadores de performance dos veículos
\n

Indicators

\n

Esse objeto representa os nossos indicadores de performance, eles serão descritos abaixo.

\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\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
IndicadorDescrição
score (Nota Geral)Nota geral do desempenho de direção econômica do caminhão.
movement (Tempo em Movimento)Tempo total que o veículo esteve em movimento
greenRange (Total da Faixa Verde)Tempo total que o veículo rodou dentro da faixa verde de rotação do motor.
extraEconomicRange (Início da Faixa Verde)Tempo total de exposição do veículo ao início de faixa verde de rotação do veículo.
economicRange (Final da Faixa Verde)Período que o veículo ficou exposto a faixa final de giro onde acontecem as trocas de marcha normalmente.
powerRange (Acelerando Acima do Verde)Tempo que o veículo foi conduzido acima da faixa verde incorrendo em maior consumo
leverage (Aproveitamento de Embalo)Tempo total que o veículo rodou aproveitando sem aceleração, gerando economia de combustível
speeding (Excesso de Velocidade)Tempo total que o veículo esteve com a velocidade acima do padrão configurado em nossa plataforma.
engineBreak (Freio Motor)Tempo de exposição do veículo ao freio motor, sem aceleração
cruiseControl (Piloto AutomáticoTempo que o veículo trafegou com o piloto automático ativo.
ecoRoll (Eco Roll/ I-Roll)Tempo de exposição do veículo em eco-roll ou i-roll
idle (Motor Ligado Parado)Tempo que o veículo passou ligado sem movimentação
pedalPressureOnLow (Pressão do pedal no range Ideal)Tempo que o veículo passou com a pressão do pedal baixa.
pedalPressureOnMid (Pressão do pedal no range Atenção)Tempo que o veículo passou com a pressão do pedal média.
pedalPressureOnHig (Pressão do pedal no range Crítico)Tempo que o veículo passou com a pressão do pedal crítico.
\n

Cada indicador vai trazer junto consigo 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\n
FieldTypeDescription
durationfloatDiz respeito ao tempo (em minutos) que o veículo passou em determinado indicador.
percentagefloatRepresenta a % de tempo que o veículo passou naquele indicador
scorefloatDiz qual foi a nota do veículo/motorista naquele indicador (Representa a conversão das estrelas que aparecem na versão Web/Aplicativo).
\n

Limites e Restrições

\n

Limite de Requisições

\n

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

Período de consulta

\n

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","v1","vehicle-performance"],"host":["gateway-v3","gobrax","com","br"],"query":[{"description":{"content":"

(obrigatório) Deve ser preenchido com o horário de início da análise, o formato das datas deve respeitar os seguintes padrões: YYYY-MM-DD HH:MM:SS

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

(obrigatório) Deve ser preenchido com o horário de fim da análise, o formato das datas deve respeitar os seguintes padrões: YYYY-MM-DD HH:MM:SS

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

(opcional) Deve ser preenchido com a PLACA do veículo, o campo deve receber apenas letras e números, sem a necessidade de espaços ou caracteres de separação como hífens (-) ou barras (/). Exemplo: ABC1234

\n","type":"text/plain"},"key":"vehicleIdentification","value":""}],"variable":[]}},"response":[{"id":"e2029766-6f49-4e16-ad19-8bb3fb4a00a6","name":"OK - Vehicle Performance successfully retrieved for all vehicles","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-performance?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","v1","vehicle-performance"],"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 \"drivers\": [\n {\n \"driverName\": \"MARCOS SANTOS\",\n \"cpf\": \"11122233344\",\n \"startDate\": \"2022-10-03T00:00:00+0000\",\n \"endDate\": \"2022-10-07T23:59:59+0000\"\n }\n ],\n \"indicators\": {\n \"cruiseControl\": {\n \"duration\": 0,\n \"percentage\": 0,\n },\n \"ecoRoll\": {\n \"duration\": 2.5,\n \"percentage\": 0.64,\n },\n \"economicRange\": {\n \"duration\": 144.01,\n \"percentage\": 36.92,\n \"score\": 1\n },\n \"engineBrake\": {\n \"duration\": 33.48,\n \"percentage\": 8.58,\n \"score\": 2\n },\n \"extraEconomicRange\": {\n \"duration\": 197.1,\n \"percentage\": 50.53,\n \"score\": 3\n },\n \"greenRange\": {\n \"duration\": 341.11,\n \"percentage\": 87.46,\n \"score\": 4\n },\n \"idle\": {\n \"duration\": 14.5,\n \"percentage\": 3.71,\n \"score\": 5\n },\n \"leverage\": {\n \"duration\": 82.98,\n \"percentage\": 21.27,\n \"score\": 5\n },\n \"movement\": {\n \"duration\": 390,\n \"percentage\": 100,\n \"score\": 6\n },\n \"powerRange\": {\n \"duration\": 12.5,\n \"percentage\": 3.20,\n \"score\": 7\n },\n \"speeding\": {\n \"duration\": 24.05,\n \"percentage\": 6.16,\n \"score\": 8\n },\n \"pedalPressureOnLow\": {\n \"duration\": 130.0,\n \"percentage\": 33.33,\n \"score\": 28\n },\n \"pedalPressureOnMid\": {\n \"duration\": 130.0,\n \"percentage\": 33.33,\n \"score\": 2\n },\n \"pedalPressureOnHigh\": {\n \"duration\": 130.0,\n \"percentage\": 33.33,\n \"score\": 21\n },\n },\n },\n {\n \"vehicleIdentification\": \"DDD-4444\",\n \"startDate\": \"2021-12-12 00:00:00\",\n \"endDate\": \"2021-12-12 15:00:00\",\n \"indicators\": {\n \"cruiseControl\": {\n \"duration\": 0,\n \"percentage\": 0,\n \"score\": 2,\n },\n \"ecoRoll\": {\n \"duration\": 2.5,\n \"percentage\": 0.64,\n \"score\": 2\n },\n \"economicRange\": {\n \"duration\": 144.01,\n \"percentage\": 36.92,\n \"score\": 2\n },\n \"engineBrake\": {\n \"duration\": 33.48,\n \"percentage\": 8.58,\n \"score\": 2\n },\n \"extraEconomicRange\": {\n \"duration\": 197.1,\n \"percentage\": 50.53,\n \"score\": 2\n },\n \"greenRange\": {\n \"duration\": 341.11,\n \"percentage\": 87.46,\n \"score\": 2\n },\n \"idle\": {\n \"duration\": 14.5,\n \"percentage\": 3.71,\n \"score\": 2\n },\n \"leverage\": {\n \"duration\": 82.98,\n \"percentage\": 21.27,\n \"score\": 2\n },\n \"movement\": {\n \"duration\": 390,\n \"percentage\": 100,\n \"score\": 2\n },\n \"powerRange\": {\n \"duration\": 12.5,\n \"percentage\": 3.20,\n \"score\": 2\n },\n \"speeding\": {\n \"duration\": 24.05,\n \"percentage\": 6.16,\n \"score\": 2\n },\n \"pedalPressureOnLow\": {\n \"duration\": 150.0,\n \"percentage\": 33.33,\n \"score\": 2\n },\n \"pedalPressureOnMid\": {\n \"duration\": 150.0,\n \"percentage\": 33.33,\n \"score\": 2\n },\n \"pedalPressureOnHigh\": {\n \"duration\": 150.0,\n \"percentage\": 33.33,\n \"score\": 2\n },\n },\n },\n \n ]\n}"},{"id":"bbe508d3-2e1c-45a9-888c-572d588a23aa","name":"OK - Vehicle Performance successfully retrieved for a specific vehicle","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-performance?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","v1","vehicle-performance"],"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 \"drivers\": [\n {\n \"driverName\": \"MARCOS SANTOS\",\n \"cpf\": \"11122233344\",\n \"startDate\": \"2022-10-03T00:00:00+0000\",\n \"endDate\": \"2022-10-07T23:59:59+0000\"\n }\n ], \n \"indicators\": {\n \"cruiseControl\": {\n \"duration\": 0,\n \"percentage\": 0,\n \"score\": 2\n },\n \"ecoRoll\": {\n \"duration\": 2.5,\n \"percentage\": 0.64,\n \"score\": 2\n },\n \"economicRange\": {\n \"duration\": 144.01,\n \"percentage\": 36.92,\n \"score\": 2\n },\n \"engineBrake\": {\n \"duration\": 33.48,\n \"percentage\": 8.58,\n \"score\": 2\n },\n \"extraEconomicRange\": {\n \"duration\": 197.1,\n \"percentage\": 50.53,\n \"score\": 2\n },\n \"greenRange\": {\n \"duration\": 341.11,\n \"percentage\": 87.46,\n \"score\": 2\n },\n \"idle\": {\n \"duration\": 14.5,\n \"percentage\": 3.71,\n \"score\": 2\n },\n \"leverage\": {\n \"duration\": 82.98,\n \"percentage\": 21.27,\n \"score\": 2\n },\n \"movement\": {\n \"duration\": 390,\n \"percentage\": 100,\n \"score\": 2\n },\n \"powerRange\": {\n \"duration\": 12.5,\n \"percentage\": 3.20,\n \"score\": 2\n },\n \"speeding\": {\n \"duration\": 24.05,\n \"percentage\": 6.16,\n \"score\": 2\n },\n \"pedalPressureOnLow\": {\n \"duration\": 130.0,\n \"percentage\": 33.33,\n \"score\": 2\n },\n \"pedalPressureOnMid\": {\n \"duration\": 130.0,\n \"percentage\": 33.33,\n \"score\": 2\n },\n \"pedalPressureOnHigh\": {\n \"duration\": 130.0,\n \"percentage\": 33.33,\n \"score\": 2\n },\n },\n }\n ]\n}"},{"id":"664d329b-0a7b-44aa-9215-093398e24450","name":"Bad Request - Failed to get Vehicle statistics due missing vehicle","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-performance?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-performance"],"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":"15596572-650e-46b3-abae-42826b863543","name":"Bad Request - Failed to get Vehicle statistics due missing start date","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-performance?endDate=2021-12-15 12:00:00","protocol":"http","host":["gateway-v3","gobrax","com","br"],"port":"8888","path":["api","v1","vehicle-performance"],"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":"1b19c1b6-0a00-4aa5-9b28-c7731916fed5","name":"Bad Request - Failed to get Vehicle statistics due missing end date","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://gateway-v3.gobrax.com.br:8888/api/v1/vehicle-performance?startDate=2021-12-15 12:00:00","protocol":"http","host":["gateway-v3","gobrax","com","br"],"port":"8888","path":["api","v1","vehicle-performance"],"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":"3cf1e018-0780-44e8-a91c-cf7fa9f6bd2c"}]}