Veículos

A API de Veículos permite listar e obter detalhes dos veículos vinculados aos usuários de sua organização.

Propriedades

Name
id
Type
integer
Description
ID do veículo na habilitar.me.
Name
user_id
Type
integer
Description
ID do condutor na habilitar.me.
Name
license_plate
Type
string
Description
Placa do veículo.
Name
brand
Type
string
Description
Marca do veículo.
Name
model
Type
string
Description
Modelo do veículo.
Name
color
Type
string
Description
Cor do veículo.
Name
created_at
Type
datetime
Description
Data de criação
Name
updated_at
Type
datetime
Description
Data de atualização

GET/v1/vehicles

Listar Veículos

Este endpoint permite listar os veículos vinculados aos usuários da organização.

Parâmetros opcionais

Name
page
Type
integer
Description
Página a ser exibida. Default: 1.
Name
page_size
Type
integer
Description
Quantidade de itens por página. Default: 10.

Request

GET

/v1/vehicles

curl -G https://api.habilitar.me/v1/vehicles \
  -H "api-x-token: {token}" \
  -d page=1 \
  -d page_size=10

Response

{
  "page": 1,
  "page_size": 10,
  "total": 2,
  "total_pages": 1,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "license_plate": "ABC1234",
      "brand": "Ford",
      "model": "Fusion",
      "color": "Red",
      "created_at": "2021-01-01",
      "updated_at": "2021-01-01",
    },
    {
      "id": 2,
      "user_id": 2,
      "license_plate": "DEF5678",
      "brand": "Chevrolet",
      "model": "Onix",
      "color": "Blue",
      "created_at": "2021-01-01",
      "updated_at": "2021-01-01",
    }
  ]
}

GET/v1/vehicles/:id

Detalhes do Veículo

Este endpoint permite obter os detalhes de um veículo.

Request

GET

/v1/vehicles/1

curl https://api.habilitar.me/v1/vehicles/1 \
  -H "api-x-token: {token}"

Response

{
  "id": 1,
  "user_id": 1,
  "license_plate": "ABC1234",
  "brand": "Ford",
  "model": "Fusion",
  "color": "Red",
  "created_at": "2021-01-01",
  "updated_at": "2021-01-01",
}

GET/v1/vehicles/:id/crlv

Download de CRLV

Este endpoint permite baixar o CRLV de um veículo.

Parâmetros obrigatórios

Name
user_id
Type
integer
Description
ID do condutor.
Name
reference_object_id
Type
integer
Description
ID do objeto (infração, processo).
Name
reference_object_type
Type
string
Description
Tipo do objeto (traffic_ticket, procedure).

Request

POST

/v1/vehicles/1/crlv

curl https://api.habilitar.me/v1/vehicles/1/crlv \
  -H "api-x-token: {token}" \
  -d user_id=1 \
  -d object_id=1 \
  -d object_type=traffic_ticket

Response

{
  "id": 1,
  "user_id": 1,
  "status": "pending",
  "created_at": "2021-01-01",
  "updated_at": "2021-01-01",
}