API responsável por realizar os vínculos entre motoristas e veículos de forma automatizada. Nela você poderá fazer POST do registro realizado pelo motorista, fazendo com que o início e o fim de viagem seja registrado automaticamente na plataforma web Gobrax.

Assim que o motorista estiver vinculado ao veículo, passamos a medir a performance dele em conjunto com a do veículo. Ou seja, uma vez vinculado, o motorista passa a ter sua bonificação contabilizada a partir da sua condução do veículo.

Atenção: Os campos de nossas APIs são sensíveis a maiusculas e minúsculas (case sensitive). Portanto, é essencial que todas as nomenclaturas sigam exatamente o padrão estabelecido. Caso contrário, a integração não será aceita e a API retornará um erro.

\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

Field	Type	Description
vehicleIdentification	string	(obrigatório) Campo que irá receber a PLACA do veículo, sem espaços antes ou depois da placa, seguindo o padrão registrado em nosso banco de dados (ABC1234). IMPORTANTE: O campo deve receber apenas letras e números, sem a necessidade de qualquer carácter de separação (como hífens, espaços ou barras).
driverIdentification	string	(obrigatório) Campo que recebe o CPF do motorista, cadastrado em nosso banco de dados. IMPORTANTE: O campo deve receber apenas números, sem a necessidade de qualquer carácter de separação (como hífens, espaços ou barras). Manter o cadastro dos motoristas atualizado é essencial para o bom funcionamento do serviço, nos contate sempre que precisar atualizar a sua base de motoristas através do email suporte@gobrax.com.br.
eventType	int	(obrigatório) Esse campo serve para informar se essa macro diz respeito ao início de uma viagem ou ao fim de uma viagem. 1 - Evento de início de viagem; 2 - Evento de término de viagem. IMPORTANTE: O tipo de evento deve seguir rigorosamente a rotina, evento 1 para início de viagem, evento 2 para fim de viagem. Se o tipo de evento for 2 e a requisição não possuir um endDate a API retornará erro.
eventIdentification	string	(opcional) O campo serve para identificações internas, pode ser usada para identificar cada evento registrado internamente.
eventDescription	string	(opcional) O campo serve para identificações internas, pode ser usada para identificar cada evento registrado internamente.
startDate	string	(obrigatório) Deve ser preenchido com o horário do início de viagem do motorista, o formato das datas deve respeitar os seguintes padrões: YYYY-MM-DD HH:MM:SS, por exemplo: 2024-01-01 03:00:00 IMPORTANTE: Se o campo endDate não for preenchido, o motorista permanecerá como motorista atual do veículo correspondente. O campo startDate é obrigatório em todas as requisições. Se o campo endDate for anterior ao startDate a API retornará um erro, indicando o problema. Se o padrão de datas não for respeitado, a API também retornará erro. Se o modelo UTC não for seguido, os horários de vínculos do motorista serão impactados, ficando com três horas de diferença para a realidade.
endDate	string	(obrigatório) Deve ser preenchido com o horário do fim da viagem do motorista, o formato deve respeitar os seguintes padrões: YYYY-MM-DD HH:MM:SS, por exemplo: 2024-01-01 03:00:00 IMPORTANTE: Se o campo endDate não for preenchido, o motorista permanecerá como motorista atual do veículo correspondente. O campo startDate é obrigatório em todas as requisições. Se o campo endDate for anterior ao startDate a API retornará um erro, indicando o problema. Se o padrão de datas não for respeitado, a API também retornará erro. Se o modelo UTC não for seguido, os horários de vínculos do motorista serão impactados, ficando com três horas de diferença para a realidade.
forceAssign	string	(obrigatório) Em situações onde os vínculos não forem registrados em ordem cronológica e houver a necessidade de inserir um registro entre outros já existentes, o forceAssign irá servir para que você consiga inserir esse vínculo, mesmo que já exista registros após a finalização desse vínculo. Por exemplo: Vamos imaginar que o motorista A viajou com o veículo das 10:00 às 14:00, e depois disso o motorista B viajou das 14:01 até as 18:00. Por algum motivo, o registro do motorista A não foi executado na ordem cronológica correta e você precisa inserir esse registro, sem influenciar a viagem do motorista B. Se você assinalar true -> O vínculo do motorista A será registrado sem afetar o vínculo do motorista B. Se você assinalar false -> O vínculo do motorista A não será registrado e a API vai retornar erro por entender que esse vínculo está fora da ordem cronológica (Isso é feito para evitar que o motorista B seja afetado por um vínculo anterior que não foi registrado). IMPORTANTE: Caso muitos vínculos tenham sido feitos depois desse que não foi registrado, orientamos a enviar esse vínculo, juntamente com os demais que vieram na sequência, assinalando o campo como TRUE, com isso todos os vínculos estarão na ordem cronológica desejável

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.

Nossa API possui uma instância intermediadora que recebe os vínculos e os processa no banco de dados de 5 em 5 minutos. Dessa forma, o vínculo pode demorar até 5 minutos para ser processado na plataforma web.

Autenticação

Vehicle Event

Limites e Restrições

Limite de Requisições