Condutores

A API de Condutores permite criar, listar e obter detalhes dos condutores vinculados à sua organização. Ao criar um condutor, o sistema valida o CPF e busca automaticamente as informações da CNH associada.

Propriedades

Name
id
Type
number
Description
ID único do condutor.
Name
license
Type
string
Description
Número de registro da CNH.
Name
name
Type
string
Description
Nome completo.
Name
tax_id
Type
string
Description
CPF.
Name
issue_date
Type
string
Description
Data de emissão da CNH no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
Name
expiration_date
Type
string
Description
Data de validade da CNH no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
Name
created_at
Type
string
Description
Data e hora em que o condutor foi criado em nosso sistema no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).

GET/v1/drivers/

Listar Condutores

Retorna uma lista paginada de todos os condutores.

Parâmetros de Paginação

Name
pagination[page]
Type
integer
Description
Número da página (começando em 1). Use junto com pagination[size].
Name
pagination[size]
Type
integer
Description
Tamanho da página (número de itens por página, máximo 100). Use junto com pagination[page].

Request

GET

/v1/driver-licenses/

curl -G https://api.habilitar.me/v1/driver-licenses/ \
  -H "x-api-key: {token}" \
  -d "pagination[page]=1" \
  -d "pagination[size]=10"

Response

{
  "data": [
    {
      "id": 1,
      "license": "12345678900",
      "name": "João da Silva",
      "tax_id": "12345678900",
      "issue_date": "2022-05-10T00:00:00Z",
      "expiration_date": "2032-05-10T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z"
    },
    {
      "id": 2,
      "license": "98765432100",
      "name": "Maria Oliveira",
      "tax_id": "98765432100",
      "issue_date": "2020-03-15T00:00:00Z",
      "expiration_date": "2030-03-15T00:00:00Z",
      "created_at": "2024-01-15T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10
  },
  "total": 2
}

GET/v1/drivers/{id}

Detalhar Condutor - id

Retorna os detalhes completos de um condutor específico.

Parâmetros de Rota

Name
id
Type
number
Required
obrigatório
Description
ID do condutor que deseja consultar.

Request

GET

/v1/driver-licenses/{id}

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

Response - 200

{
  "data": {
    "id": 1,
    "license": "12345678900",
    "name": "João da Silva",
    "tax_id": "12345678900",
    "issue_date": "2022-05-10T00:00:00Z",
    "expiration_date": "2032-05-10T00:00:00Z",
    "created_at": "2024-01-01T00:00:00Z"
  }
}

Response - 404

{
  "error": "Condutor não encontrado"
}

POST/v1/drivers/

Criar Condutor

Cria um novo condutor a partir do CPF informado. O sistema irá validar e buscar as informações da CNH do condutor.

Parâmetros do Body

Name
tax_id
Type
string
Required
obrigatório
Description
CPF do condutor.

Request

POST

/v1/drivers/

curl -X POST https://api.habilitar.me/v1/drivers/ \
  -H "x-api-key: {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "tax_id": "12345678900"
  }'

Response - 201

{
  "data": {
    "id": 1,
    "license": "12345678900",
    "name": "João da Silva",
    "tax_id": "12345678900",
    "issue_date": "2022-05-10T00:00:00Z",
    "expiration_date": "2032-05-10T00:00:00Z",
    "created_at": "2024-01-10T14:30:00Z"
  }
}

Response - 400

{
  "error": "CPF inválido",
  "message": "O CPF informado não é válido"
}

Response - 404

{
  "error": "CNH não encontrada",
  "message": "Não foi possível encontrar CNH para o CPF informado"
}