Pular para o conteúdo principal

Event

Documentação da API: Consulta de Eventos

Este documento descreve como utilizar o endpoint para consultar eventos do sistema, permitindo a filtragem por veículos, motoristas, período, entre outros critérios.

Endpoint​

Recupera uma lista de eventos com base nos parâmetros de filtro fornecidos.

  • Método: GET
  • URL: https://api.webrota.com.br/event/

Autenticação (Authorization)​

Todas as requisições a este endpoint devem ser autenticadas. A autenticação é realizada através do envio de um token de acesso (access token) no cabeçalho (header) da requisição.

  • Header: Authorization
  • Formato: Bearer <seu_token_aqui>

Substitua <seu_token_aqui> pelo seu token de acesso válido. A ausência ou invalidade do token resultará em uma resposta de erro 401 Unauthorized.

Exemplo de Cabeçalho (Header)​

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Exemplo com cURL​

Abaixo está um exemplo de como a requisição completa, incluindo o cabeçalho de autorização, seria feita utilizando a ferramenta de linha de comando cURL:

curl -X GET \
  -H "Authorization: Bearer <seu_token_aqui>" \
  "https://api.webrota.com.br/event/?vehicles_id=%5B99999%5D&periods=%5B%7B%22begin%22:%222025-10-02T03:00:00.000Z%22,%22end%22:%222025-10-10T02:59:00.000Z%22%7D%5D"

Parâmetros de Consulta (Query Parameters)​

Os parâmetros devem ser enviados na URL da requisição.

ParâmetroTipoObrigatoriedadeDescrição
aggregated_fieldstringOpcionalDefine o campo pelo qual os resultados serão agregados. No exemplo, vehicle agrupa os eventos por veículo.
vehicles_idarray[integer]Condicional¹Um array contendo os IDs dos veículos a serem consultados. Ex: [99999].
driver_idsarray[integer]Condicional¹Um array contendo os IDs dos motoristas a serem consultados. Ex: [] (vazio).
distanceintegerOpcionalFiltra eventos que tenham uma distância percorrida maior ou igual ao valor especificado (em metros). Ex: 100.
periodsarray[object]ObrigatórioDefine o intervalo de tempo para a consulta. É um array de objetos, onde cada objeto possui uma chave begin e end com datas no formato ISO 8601 (UTC). Ex: [{"begin":"2025-10-02T03:00:00.000Z", "end":"2025-10-10T02:59:00.000Z"}].
event_categoryintegerObrigatórioFiltra os eventos por uma categoria específica, representada por um ID numérico. Ex: 1 que é viagem.
includesstringOpcionalUma lista de recursos relacionados para serem incluídos na resposta, separados por vírgula. Isso evita a necessidade de chamadas adicionais à API.

¹Pelo menos um dos parâmetros vehicles_id ou driver_ids deve ser fornecido.

Categorias de Evento (event_category)​

Abaixo estão os valores possíveis para o parâmetro event_category.

  • ID | Descrição
  • 1 | Viagem
  • 2 | Excesso de velocidade
  • 3 | Movimentação em cerca
  • 4 | Fora de expediente
  • 5 | Aproximação
  • 6 | Ocioso
  • 7 | Identificação de cartão
  • 8 | Sensor Entrada 1
  • 9 | Sensor Entrada 2
  • 10 | Desconexão de fonte principal
  • 11 | Aceleração brusca
  • 12 | Frenagem brusca
  • 13 | Curva acentuada
  • 14 | Jornada de trabalho
  • 22 | Fim de jornada
  • 23 | Reinício de viagem
  • 24 | Botão de pânico
  • 25 | Identificação de cartão inválido
  • 26 | RPM máximo excedido
  • 27 | Veículo desengrenado
  • 28 | Temperatura mínima excedida
  • 29 | Temperatura máxima excedida
  • 30 | Campo customizado Dados
  • 31 | Identificação de Passageiro

O Parâmetro includes​

Este parâmetro é poderoso para enriquecer a resposta com dados relacionados, diminuindo a quantidade de requisições. Os valores possíveis (com base no exemplo) são:

  • position_start: Posição GPS de início do evento.
  • position_end: Posição GPS de fim do evento.
  • location_start: Endereço (geocodificado) de início do evento.
  • location_end: Endereço (geocodificado) de fim do evento.
  • position_start.virtual_area: Área virtual (cerca eletrônica) associada à posição inicial.
  • position_end.virtual_area: Área virtual (cerca eletrônica) associada à posição final.
  • device: Informações sobre o dispositivo/rastreador.
  • vehicle: Detalhes completos do veículo.
  • vehicle.vehicle_color: Cor do veículo.
  • driver: Detalhes do motorista associado.
  • poi_start: Ponto de Interesse (POI) associado ao início do evento.
  • poi_end: Ponto de Interesse (POI) associado ao fim do evento.

Exemplo de Requisição (URL Completa)​

GET https://api.webrota.com.br/event/?aggregated_field=vehicle&vehicles_id=%5B99999%5D&driver_ids=%5B%5D&distance=100&periods=%5B%7B%22begin%22:%222025-10-02T03:00:00.000Z%22,%22end%22:%222025-10-10T02:59:00.000Z%22%7D%5D&event_category=1&includes=position_start,position_end,location_start,location_end,device,vehicle,driver

Respostas da API​

Sucesso​

  • Código: 200 OK
  • Conteúdo: Um array de objetos, onde cada objeto representa um evento que corresponde aos critérios de busca.

Exemplo de Corpo da Resposta (Estrutura)

[
  {
    "id": 12345,
    "event_category": 1,
    "begin_date": "2025-10-02T10:00:00.000Z",
    "end_date": "2025-10-02T10:30:00.000Z",
    "distance": 1500,
    "vehicle": {
      "id": 99999,
      "plate": "ABC-1234",
      "model": "Modelo Exemplo"
    },
    "driver": {
      "id": 987,
      "name": "João da Silva"
    },
    "location_start": {
      "address": "Rua Exemplo de Início, 123, São Paulo, SP"
    },
    "location_end": {
      "address": "Avenida Exemplo de Fim, 456, São Paulo, SP"
    }
  }
]