Manual de Integrao de Conduo Detalhada

ndice
ndice
Termo de Confidencialidade e Sigilo
Histrico de Alteraes
Integrao
Autenticao
Controle de requisio
Conduo Detalhada
Exemplos de chamada
Formato da Mensagem
Descrio dos campos do JSON
Descrio dos campos do Motorista
Descrio dos campos do Veculo
Descrio dos campos da UO
Consulta de reprocessamento
Descrio dos campos do JSON

Termo de Confidencialidade e Sigilo

O contedo deste documento restrito aos parceiros e clientes da empresa Trimble Transportation Latam. proibida a distribuio deste documento a pessoas
no autorizadas.

Histrico de Alteraes
Reviso Data Alterao

1.0 19/10/2021 Documento inicial

1.1 15/12/2021 Incrementa informaes sobre resposta da api

1.2 28/03/2022 Adiciona campos de ID (identificador) para Veculo e UO (Unidade Organizacional)

Integrao
A integrao tem como objetivo fornecer informaes consolidadas do histrico do veculo, onde sero fornecidos dados de direo segura e conduo econmica dos
veculos permitidos para uma devida gesto, onde permite obter as informaes de motoristas e seus respectivos apontamentos. Todos os dados so
fornecidos a partir de uma data representando o intervalo de um nico dia.

Autenticao
A autenticao adotada baseada no uso de Tokens de aplicao. Em toda requisio necessrio fornecer o mesmo. A partir do Token usado na requisio, o prprio
sistema buscar os registros permitidos e retornar as respectivas informaes.
O Token a ser utilizado ser fornecido anteriormente para o cliente que contratar este servio.

Controle de requisio
Com o objetivo de controlar a quantidade de acesso aos servidores, limitado o uso de uma nica requisio a cada 5 minutos. Toda tentativa de acesso
aos servidores com o mesmo token em um intervalo inferior aos 5 minutos resultar na exceo com cdigo 429: too many requests.
Mais informaes sobre o cdigo 429: _https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Status/429_

Conduo Detalhada
Nesta API, para obter as informaes, tm como parmetro um formato de data no padro YYYY-MM-DD (ex: 2021-10-25). Caso a data no seja fornecida, o dia
anterior ao atual ser utilizado como padro, a API aceita tambm filtro opcional por veculo, informado um queryParam "veiculoIds".

Esta chamada retornar todos os dados da rota do motorista, contendo dados de conduo econmica e segura no mesmo resultado.

Quando os campos "inicio" e "fim" forem nulos, os valores do objeto sero a soma de todos eventos que ocorreram no dia do veculo nos
perodos em que no houve identificao de motorista.

Quando o campo "fim" for preenchido com data e no possuir vigncia no dia, a data ser do ltimo evento reportado pelo veculo.

Exemplos de chamada
Uma requisio para a URL https://api.vfleets.com.br/integrationcore-conducao/conducoes/detalhada , utilizando o mtodo GET e passando o token no
headers cujo value seja authorization.

Exemplos:

Chamada usando como padro o dia de ontem

Chamada

curl -H "Authorization: TOKEN_AUTENTICACAO"

https://api.vfleets.com.br/integrationcore-conducao/conducoes/detalhada

Chamada passando uma data como argumento

Chamada por data

curl -H "Authorization: TOKEN_AUTENTICACAO"

https://api.vfleets.com.br/integrationcore-conducao/conducoes/detalhada?dia=2021-10-19

Chamada passando filtro de data e de veculos com id 10, 20 e 30

Chamada por data e veiculos

curl -H "Authorization: TOKEN_AUTENTICACAO"

https://api.vfleets.com.br/integrationcore-conducao/conducoes/detalhada?dia=2021-10-19&veiculoIds=10,
20,30

Chamada passando filtro por data e veiculo

Chamada por data e veiculo

curl -H "Authorization: TOKEN_AUTENTICACAO"

https://api.vfleets.com.br/integrationcore-conducao/conducoes/detalhada?dia=2021-10-19&veiculoIds=12

Chamada passando filtro por veiculo

Chamada por veiculo

curl -H "Authorization: TOKEN_AUTENTICACAO"

https://api.vfleets.com.br/integrationcore-conducao/conducoes/detalhada?veiculoIds=10,20

Formato da Mensagem
Exemplo de JSON de resposta com velocidade agrupada

[
{
"dia":"2016-04-01",
"inicio":"2016-04-01T08:00:00-03:00",
"fim":"2016-04-01T10:00:00-03:00",
"kmInicial":59600000,
"kmFinal":60000000,
"velocidadeFaixa1Tempo":5,
"velocidadeFaixa1Qtd":1,
"velocidadeFaixa2Tempo":10,
"velocidadeFaixa2Qtd":1,
"velocidadeFaixa3Tempo":15,
"velocidadeFaixa3Qtd":1,
"logradouroInicio":"Rua Par",
"logradourofim":"Rua Uruguai",
"dataProcessamento":"2016-04-03T00:00:00-03:00",
"motorista":{
"nome":"Thiago",
"cpf":"31197485600",
"rg":"500535826",
"cnh":"19881528562",
"documentoIdentificador":"ABC852X-E",
"uo":{
"uoId":2266,
"nome":"Teste Integracao"
}
},
"veiculo":{
"id":2687,
"placa":"PLACA1",
"prefixo":"LEA",
"uo":{
"uoId": 2266,
"nome":"Teste Integracao"
}
},
"motoristaAusenteQtd":0,
"remocaoEquipamentoQtd":10,
"curvasQtd":1,
"aceleracoesQtd":2,
"frenagensQtd":3,
"trepidacoesQtd":4,
"banguelaTempo":60,
"banguelaQtd":5,
"motorOciosoQtd":1,
"motorOciosoTempo":120,
"semCintoQtd":0,
"consumoParado":5000,
"consumoMovimento":10000,
"tempoMovimento":0,
"consumoGpsInvalido":1000,
"permanenciaPontoQtd":2,
"permanenciaPontoTempo":4,
"permanenciaCercaQtd":6,
"permanenciaCercaTempo":8,
"freioMotorTempo":30,
"batendoTransmissaoTempo":10,
"possivelColisaoQtd":20,
"rfidNaoCadastradoQtd":0,
"panicoQtd":0,
"sensorDesengateTempo":0,
"cameraObstruidaQtd":0,
"distracaoMotoristaQtd":0,
"distanciaPerigosaQtd":0,
"manuseioCelularQtd":0,
"usoCigarroQtd":0,
"fadigaMotoristaQtd":0,
"tempoDirecao":3600,
 "velocidadeViaFaixa1Tempo":15,
"velocidadeViaFaixa1Qtd":1,
"velocidadeViaFaixa2Tempo":15,
"velocidadeViaFaixa2Qtd":1,
"velocidadeViaFaixa3Tempo":15,
"velocidadeViaFaixa3Qtd":1,
"previsaoColisaoQtd":0,
"rpmFaixa1Tempo":60,
"rpmFaixa1Qtd":1,
"rpmFaixa2Tempo":0,
"rpmFaixa2Qtd":0,
"rpmFaixa3Tempo":0,
"rpmFaixa3Qtd":0
}
]

Descrio dos campos do JSON

Nome do Campo tipo Observao

dia DateTi Data em que motorista executou o percurso.

me

inicio DateTi Data hora que o registro da conduo iniciou. (nulo quando no houver motorista identificado)
me

fim DateTi Data hora que o registro da conduo terminou. (nulo quando no houver motorista identificado)
me

kmInicial Bigint Marcao do Hodmetro do veculo antes do percurso (em metros)

kmFinal Bigint Marcao do Hodmetro do veculo depois do percurso (em metros)

velocidadeFaixa1Te Bigint tempo em segundos que o motorista permaneceu com velocidade excedida em menos que 20% acima do limite.
mpo

velocidadeFaixa1Qtd Bigint quantidade de vezes que o motorista excedeu a velocidade em menos que de 20% acima do limite.

velocidadeFaixa2Te Bigint tempo em segundos que o motorista permaneceu com velocidade excedida em mais que 20% acima do limite, mas
mpo menos que 30% acima do limite.

velocidadeFaixa2Qtd Bigint quantidade de vezes em que o motorista excedeu a velocidade em mais que 20% acima do limite, mas menos de 30%
acima do limite.

velocidadeFaixa3Te Bigint tempo em segundos que o motorista permaneceu com velocidade excedida em mais que 30% acima do limite.
mpo

velocidadeFaixa3Qtd Bigint quantidade de vezes que o motorista excedeu a velocidade em mais que 30% acima do limite.

logradouroInicio String logradouro da posio inicial do condutor.

logradouroFim String logradouro da posio final do condutor.

dataProcessamento Bigint data-hora que o registro da conduo foi processada (GMT 0).

motoristas Motori lista de motoristas que efetuaram a conduo. No caso desta rota, esta lista deve retornar somente um motorista. Descrio
sta dos dados conforme tabela Motorista.

veculo Veculo lista de veculos que o motorista conduziu.Descrio dos dados conforme tabela Veculos

motoristaAusenteQtd Bigint quantidade de vezes que o condutor deixou de ser identificado da posio de conduo do veculo durante o perodo.

remocaoEquipamen Bigint quantidade de vezes que o equipamento do veculo perdeu a alimentao num perodo maior ou igual a 10 minutos.
toQtd

curvasQtd Bigint quantidade de vezes que o condutor efetuou uma curva brusca.velocidadeFaixa1Tempo

aceleracoesQtd Bigint quantidade de vezes que o condutor efetuou uma acelerao brusca.

frenagensQtd Bigint quantidade de vezes que o condutor efetuou uma frenagem brusca.

trepidacoesQtd Bigint quantidade de vezes que o condutor passou por uma trepidao brusca.

banguelaTempo Bigint Tempo em segundo que o condutor usou a banguela.

banguelaQtd Bigint quantidade de vezes que o condutor usou a banguela.

motorOciosoQtd Bigint quantidade de vezes que o veculo usado pelo condutor permaneceu com o motor ligado sem variao de movimento.

motorOciosoTempo Bigint tempo em segundos que o veculo usado pelo condutor permaneceu com o motor ligado sem variao de movimento.

semCintoQtd Bigint quantidade de vezes que foi identificado que o condutor no estava utilizando o cinto de segurana.

consumoParado Bigint Quantidade de combustvel consumido com o veculo parado, registrado em mililitros.

consumoMovimento Bigint Quantidade de combustvel consumido com o veculo em movimento, registrado em mililitros.

tempoMovimento Bigint Tempo em segundos que o veculo esteve em movimento.

consumoGpsInvalido Bigint Quantidade de combustvel consumido enquanto o veculo estava sem sinal de GPS, registrado em mililitros.

permanenciaPontoQ Bigint quantidade de vezes que o veculo permaneceu dentro de pontos de referncia e excedeu o tempo permitido
td configurado.

permanenciaPontoT Bigint tempo total em segundos que o veculo permaneceu dentro dos pontos de referncia e excedeu o tempo permitido
empo configurado.

permanenciaCerca Bigint quantidade de vezes que o veculo permaneceu dentro das cercas eletrnicas e excedeu o tempo permitido configurado.
Qtd

permanenciaCercaT Bigint tempo total em segundos que o veculo permaneceu dentro das cercas eletrnicas e excedeu o tempo permitido
empo configurado.

freioMotorTempo Bigint tempo em segundos em que o veculo usado pelo condutor permaneceu com o uso do freio motor do limite configurado.

batendoTransmissa Bigint tempo em segundos em que o veculo usado pelo condutor permaneceu com batendo transmisso do limite configurado.
oTempo

possivelColisaoQtd Bigint Quantidade de vezes em que o veculo usado pelo condutor sofreu uma quase coliso.

rfidNaoCadastradoQ Bigint Quantidade de vezes que um carto rfid no cadastrado foi identificado no veculo.
td

panicoQtd Bigint Quantidade de vezes que o boto de pnico foi pressionado.

sensorDesengateTe Bigint Tempo em segundos que o sensor de desengate ficou acionado pelo condutor.
mpo

cameraObstruidaQtd Bigint Quantidade de vezes que o veculo usado pelo condutor teve as cmeras obstrudas.

distracaoMotoristaQ Bigint Quantidade de vezes que o condutor do veculo apresentou sinais de distrao.
td

distanciaPerigosaQtd Bigint Quantidade de vezes que o veculo usado pelo condutor aproximou de um outro veculo. Um limiar usado para
determinar a distncia perigosa.

manuseioCelularQtd Bigint Quantidade de vezes que condutor usou celular/smartphones durante a conduo.

usoCigarroQtd Bigint Quantidade de vezes que o condutor usou cigarro ou outros derivados do tabaco.

fadigaMotoristaQtd Bigint Quantidade de vezes que o condutor demonstrou sinais de fadiga.

tempoDirecao Bigint Tempo em segundos que o motorista permaneceu vigente.

velocidadeViaFaixa Bigint Tempo em segundos que o veculo permaneceu com a velocidade at 20% acima do limite da via.
1Tempo

velocidadeViaFaixa Bigint Quantidade de vezes que o motorista excedeu a velocidade at 20% acima do limite da via.
1Qtd

velocidadeViaFaixa Bigint Tempo em segundos que o motorista permaneceu com velocidade excedida em mais que 20% acima do limite, mas
2Tempo menos que 30% acima do limite.

velocidadeViaFaixa Bigint Quantidade de vezes em que o motorista excedeu a velocidade em mais que 20% acima do limite, mas menos de 30%
2Qtd acima do limite.

velocidadeViaFaixa Bigint Tempo em segundos que o motorista permaneceu com velocidade excedida em mais que 30% acima do limite.
3Tempo

velocidadeViaFaixa Bigint Quantidade de vezes que o motorista excedeu a velocidade em mais que 30% acima do limite.
3Qtd

previsaoColisaoQtd Bigint Quantidade de vezes em que o veculo usado pelo condutor detectou uma quase coliso.

rpmFaixa1Tempo Bigint Tempo em segundos da RPM conforme configurado na faixa.

 rpmFaixa1Qtd Bigint Tempo em segundos da RPM conforme configurado na faixa.

rpmFaixa2Tempo Bigint Tempo em segundos da RPM conforme configurado na faixa.

rpmFaixa2Qtd Bigint Tempo em segundos da RPM conforme configurado na faixa.

rpmFaixa3Tempo Bigint Tempo em segundos da RPM conforme configurado na faixa.

rpmFaixa3Qtd Bigint Tempo em segundos da RPM conforme configurado na faixa.

quantidade de vezes que o motorista excedeu a velocidade em menos que de 20% acima do limite.

Descrio dos campos do Motorista

Nome do Campo Tipo Observao

nome String Nome do motorista

cpf String CPF do motorista

rg String RG do motorista

cnh String CNH do motorista

uo UO Unidade organizacional do motorista. Descrio dos dados conforme tabela Unidade Organizacional.

documentoIdentificador String Documento de identificao do motorista.

Descrio dos campos do Veculo

Nome do Campo Tipo Observao

id Long Identificao do veculo

placa String Placa do veculo

prefixo String Prefixo do veculo

uo UO Unidade organizacional do veculo. Descrio dos dados conforme tabela Unidade Organizacional.

Descrio dos campos da UO

Nome do Tipo Observao
Campo

uoId Long Identificao da Unidade Organizacional

nome String Nome da unidade organizacional.

Consulta de reprocessamento
Uma requisio para a URL https://api.vfleets.com.br/integrationcore-conducao/processamentos , utilizando o mtodo GET e passando o token no headers
cujo value seja authorization.

Exemplos:

Chamada passando consulta de reprocessamentos feitos no dia 10/09/2019

curl -H "Authorization: TOKEN_AUTENTICACAO"

https://api.vfleets.com.br/integrationcore-conducao/processamentos?inicio=2019-09-10&fim=2019-09-10

Chamada passando filtro pelos veculos com id 10, 20 e 30

curl -H "Authorization: TOKEN_AUTENTICACAO"

https://api.vfleets.com.br/integrationcore-conducao/processamentos?inicio=2019-09-10&fim=2019-09-
10&veiculoIds=10,20,30

Chamada passando consulta de reprocessamentos feitos entre 09/09/2019 e 10/09/2019

 curl -H "Authorization: TOKEN_AUTENTICACAO"

https://api.vfleets.com.br/integrationcore-conducao/processamentos?inicio=2019-09-09&fim=2019-09-
10&veiculoIds=10,20,30

Exemplo de JSON de retorno

[
{
"diaConducao": "2019-09-07",
"diaReprocessamento": "2019-09-10",
"veiculoId": 10,
"veiculoUoId": 112233
},
{
"diaConducao": "2019-09-07",
"diaReprocessamento": "2019-09-10",
"veiculoId": 20,
"veiculoUoId": 667788
}
]

Descrio dos campos do JSON

Nome do Campo Tipo Descrio

diaConducao Date Referente a qual dia de conduo os dados foram reprocessados

diaReprocessamento Date Referente ao dia em que foi realizado o reprocessamento

veiculoId Bigint Referente ao identificador de qual veculo foi reprocessado

veiculoUoId Bigint Referente a qual o identificador da Unidade Organizacional o veculo

Obs: A data inicio e fim informada nos filtros da API de "/processamentos", filtrar os dados pelo campo "diaReprocessamento", ou seja, pela data
em que foi realizado o reprocessamento.

Colaborao

Elias Fernandes
Lucio Kawafigashi
Marco Bidoia