Habilitar.me

Logins

A API de Logins permite listar e obter detalhes de contas compartilhadas pelos condutores e integrados à serviços integrados pela habilitar.me.

Propriedades

  • Name
    id
    Type
    integer
    Description

    ID do login na habilitar.me.

  • Name
    user_id
    Type
    integer
    Description

    ID do usuário na habilitar.me.

  • Name
    username
    Type
    string
    Description

    Username do login.

  • Name
    status
    Type
    string
    Description

    Status do login.

  • Name
    service
    Type
    string
    Description

    Serviço do login (govbr)

  • Name
    last_accessed_at
    Type
    timestamp
    Description

    Data do último acesso do login.

  • Name
    created_at
    Type
    timestamp
    Description

    Data de criação do login.

  • Name
    updated_at
    Type
    timestamp
    Description

    Data de atualização do login.

GET/v1/logins

Listar Logins

Este endpoint permite listar uma lista paginada de todos os logins. Por padrão, são mostrados até 10 logins por página.

Optional attributes

  • 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
    status
    Type
    string
    Description

    Status do login. Default: active.

Request

GET
/v1/logins
curl -G https://api.habilitar.me/v1/logins \
  -H "x-api-key: {api_key}" \
  -d page=1 \
  -d page_size=10

Response

{
  "page": 1,
  "page_size": 10,
  "total": 2,
  "total_pages": 1,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "username": "1234567890",
      "status": "active",
      "service": "govbr",
      "last_accessed_at": "2021-01-01T00:00:00Z",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    },
    {
      "id": 2,
      "user_id": 2,
      "username": "1234567890",
      "status": "active",
      "service": "govbr",
      "last_accessed_at": "2021-01-01T00:00:00Z",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ]
}
GET/v1/logins/:id

Detalhes do login

Este endpoint permite obter um login por meio do id do login.

Request

GET
/v1/logins/1
curl https://api.habilitar.me/v1/logins/1 \
  -H "x-api-key: {api_key}"

Response

{
  "id": 1,
  "user_id": 1,
  "username": "1234567890",
  "status": "active",
  "service": "govbr",
  "last_accessed_at": "2021-01-01T00:00:00Z",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}
DELETE/v1/logins/:id

Apagar login

Este endpoint permite apagar um login.

As informações extraídas a partir do login não serão deletadas, mas não serão mais atualizadas.

Request

DELETE
/v1/logins/1
curl -X DELETE https://api.habilitar.me/v1/logins/1 \
  -H "x-api-key: {api_key}"

Essa página foi útil?