Usuários

A API de Usuários permite criar, listar e obter detalhes dos usuários vinculados a sua organização.

Propriedades

Name
id
Type
integer
Description
ID do usuário na habilitar.me.
Name
external_id
Type
string
Description
ID do usuário na sua base de dados.
Name
name
Type
string
Description
Nome do usuário.
Name
email
Type
string
Description
Email do usuário.
Name
status
Type
string
Description
Status do usuário (active, inactive).
Name
created_at
Type
datetime
Description
Data de criação
Name
updated_at
Type
datetime
Description
Data de atualização

GET/v1/users

Listar Usuários

Este endpoint permite listar os usuários vinculados a sua 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.
Name
external_id
Type
string
Description
ID do usuário na sua base de dados.

Request

GET

/v1/users

curl -G https://api.habilitar.me/v1/users \
  -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,
      "external_id": 1,
      "name": "John Doe",
      "email": "john.doe@example.com",
      "status": "active",
      "created_at": "2021-01-01",
      "updated_at": "2021-01-01",
    },
    {
      "id": 2,
      "external_id": 2,
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "status": "inactive",
      "created_at": "2021-01-01",
      "updated_at": "2021-01-01",
    }
  ]
}

GET/v1/users/(:id|:external_id)/traffic-violations

Infrações

Este endpoint permite obter as infrações de um usuário.

Request

GET

/v1/users/1/traffic-violations

curl https://api.habilitar.me/v1/users/1/traffic-violations \
  -H "x-api-key: {token}"

Response

{
  "id": 1,
  "external_id": 1,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "status": "active",
  "created_at": "2021-01-01",
  "updated_at": "2021-01-01",
}

GET/v1/users/(:id|:external_id)/vehicles

Veículos

Este endpoint permite obter os veículos de um usuário.

Request

GET

/v1/users/1/vehicles

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

Response

{
  "id": 1,
  "external_id": 1,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "status": "active",
  "created_at": "2021-01-01",
  "updated_at": "2021-01-01",
}

GET/v1/users/(:id|:external_id)/appeals

Recursos

Este endpoint permite obter os recursos de um usuário.

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.
Name
external_id
Type
string
Description
ID do usuário na sua base de dados.

Request

GET

/v1/users/1/appeals

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

Response

{
  "page": 1,
  "page_size": 10,
  "total": 2,
  "total_pages": 1,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "legal_instance": "dp",
      "status": "deferred",
      "created_at": "2021-01-01",
      "updated_at": "2021-01-01",
    },
    {
      "id": 2,
      "user_id": 2,
      "legal_instance": "jari",
      "status": "pending",
      "created_at": "2021-01-01",
      "updated_at": "2021-01-01",
    }
  ]
}