Habilitar.me

Infrações

A API de Infrações permite listar e obter detalhes das infrações de condutores conectados à sua organização. As informações são coletadas através da autenticação dos usuários via widget de login.

Propriedades

  • Name
    id
    Type
    number
    Description

    ID único da infração.

  • Name
    auto
    Type
    string
    Description

    Número do auto de infração.

  • Name
    code
    Type
    string
    Description

    Código da infração.

  • Name
    breakdown
    Type
    string
    Description

    Desdobramento da infração.

  • Name
    license_plate
    Type
    string
    Description

    Placa do veículo autuado.

  • Name
    description
    Type
    string
    Description

    Descrição detalhada da infração.

  • Name
    status
    Type
    string
    Description

    Status atual da infração. Valores possíveis:

    ValorDescrição
    PendenteInfração pendente de pagamento
    PagoInfração paga
    CanceladaInfração cancelada
    Em RecursoInfração em processo de recurso
  • Name
    written_warning
    Type
    boolean
    Description

    Indica se a infração resultou em advertência por escrito.

  • Name
    amount
    Type
    number
    Description

    Valor em reais da infração.

  • Name
    date
    Type
    string
    Description

    Data e hora da infração no formato "YYYY-MM-DD HH:mm:ss".

  • Name
    violation_notice_date
    Type
    string
    Description

    Data de autuação da infração no formato "YYYY-MM-DD".

  • Name
    penalty_notice_date
    Type
    string
    Description

    Data de notificação de penalidade no formato "YYYY-MM-DD".

  • Name
    location
    Type
    string
    Description

    Endereço ou local onde ocorreu a infração.

  • Name
    latitude
    Type
    number
    Description

    Latitude geográfica do local da infração.

  • Name
    longitude
    Type
    number
    Description

    Longitude geográfica do local da infração.

  • Name
    payment_date
    Type
    string
    Description

    Data de pagamento da infração no formato "YYYY-MM-DD".

  • Name
    due_date
    Type
    string
    Description

    Data de vencimento da penalidade no formato "YYYY-MM-DD".

  • Name
    offender_nomination_deadline
    Type
    string
    Description

    Data limite para indicação do infrator no formato "YYYY-MM-DD".

  • Name
    preliminary_appeal_deadline
    Type
    string
    Description

    Data limite para recurso em defesa prévia no formato "YYYY-MM-DD".

  • Name
    notice_appeal_deadline
    Type
    string
    Description

    Data limite para recurso de notificação no formato "YYYY-MM-DD".

  • Name
    reference
    Type
    object
    Description

    Informações de referência da infração.

    • Name
      legal_basis
      Type
      string
      Description

      Artigo do Código de Trânsito Brasileiro (CTB).

    • Name
      severity
      Type
      string
      Description

      Gravidade da infração (ex: "minor", "medium", "serious", "very_serious").

    • Name
      multiplier
      Type
      string
      Description

      Multiplicador de valor da infração.

    • Name
      points
      Type
      string
      Description

      Quantidade de pontos da infração na CNH.

  • Name
    user
    Type
    object
    Description

    Informações do usuário associado à infração.

    • Name
      id
      Type
      string
      Description

      ID do usuário.

    • Name
      external_uid
      Type
      string
      Description

      Identificador externo do usuário.

  • Name
    company
    Type
    object
    Description

    Informações da empresa associada à infração.

    • Name
      id
      Type
      number
      Description

      ID da empresa.

    • Name
      name
      Type
      string
      Description

      Nome da empresa.

GET/v1/traffic-violations/

Listar Infrações

Retorna uma lista paginada de todas as infrações.

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/traffic-violations/
curl -G https://api.habilitar.me/v1/traffic-violations/ \
  -H "x-api-key: {token}" \
  -d "pagination[page]=1" \
  -d "pagination[size]=10"

Response

{
  "data": [
    {
      "id": 1,
      "auto": "R123456789",
      "code": "1234567890",
      "breakdown": "0",
      "license_plate": "ABC1234",
      "description": "Excesso de velocidade",
      "status": "Pendente",
      "written_warning": false,
      "amount": 100.9,
      "date": "2024-01-01 12:00:00",
      "violation_notice_date": "2024-01-01",
      "penalty_notice_date": "2024-01-15",
      "location": "Av. Paulista, 1000 - São Paulo/SP",
      "latitude": -23.561684,
      "longitude": -46.655981,
      "payment_date": null,
      "due_date": "2024-02-01",
      "offender_nomination_deadline": "2024-01-20",
      "preliminary_appeal_deadline": "2024-01-25",
      "notice_appeal_deadline": "2024-01-30",
      "reference": {
        "legal_basis": "218-I",
        "severity": "medium",
        "multiplier": "1",
        "points": "4"
      },
      "user": {
        "id": "1",
        "external_uid": "EXT_USER_12345"
      },
      "company": {
        "id": 1,
        "name": "Empresa Exemplo Ltda"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10
  },
  "total": 1
}
GET/v1/traffic-violations/{id}

Detalhar Infração - id

Retorna os detalhes completos de uma infração específica.

Parâmetros de Rota

  • Name
    id
    Type
    number
    Required
    obrigatório
    Description

    ID da infração que deseja consultar.

Request

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

Response - 200

{
  "data": {
    "id": 1,
    "auto": "R123456789",
    "code": "1234567890",
    "breakdown": "0",
    "license_plate": "ABC1234",
    "description": "Excesso de velocidade",
    "status": "Pendente",
    "written_warning": false,
    "amount": 100.9,
    "date": "2024-01-01 12:00:00",
    "violation_notice_date": "2024-01-01",
    "penalty_notice_date": "2024-01-15",
    "location": "Av. Paulista, 1000 - São Paulo/SP",
    "latitude": -23.561684,
    "longitude": -46.655981,
    "payment_date": null,
    "due_date": "2024-02-01",
    "offender_nomination_deadline": "2024-01-20",
    "preliminary_appeal_deadline": "2024-01-25",
    "notice_appeal_deadline": "2024-01-30",
    "reference": {
      "legal_basis": "218-I",
      "severity": "medium",
      "multiplier": "1",
      "points": "4"
    },
    "user": {
      "id": "1",
      "external_uid": "EXT_USER_12345"
    },
    "company": {
      "id": 1,
      "name": "Empresa Exemplo Ltda"
    }
  }
}

Response - 404

{
  "error": "Infração não encontrada"
}
GET/v1/traffic-violations/{id}/indications

Indicações da Infração

Retorna uma lista paginada de todas as indicações associadas a uma infração específica.

Parâmetros de Rota

  • Name
    id
    Type
    number
    Required
    obrigatório
    Description

    ID da infração.

Request

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

Response

{
  "data": [
    {
      "id": 1,
      "flow": "automated",
      "status": "pending",
      "result": "pending",
      "processing_status": "pending",
      "processing_description": "Aguardando processamento",
      "signature_status": "unsigned",
      "driver": {
        "id": 123,
        "name": "João Silva",
        "tax_id": "12345678900"
      },
      "traffic_violation": {
        "id": 1,
        "code": "1234567890",
        "description": "Excesso de velocidade"
      },
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10
  },
  "total": 1
}

Response - 404

{
  "error": "Infração não encontrada"
}
GET/v1/traffic-violations/{id}/violation-notice

Notificação da Autuação

Retorna o arquivo PDF da notificação da autuação de uma infração específica.

Parâmetros de Rota

  • Name
    id
    Type
    number
    Required
    obrigatório
    Description

    ID da infração.

Request

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

Response - 200

Content-Type: application/pdf
Content-Disposition: attachment; filename="violation-notice-{id}.pdf"

[Binary PDF data]

Response - 404

{
  "error": "Infração não encontrada"
}

Response - 404

{
  "error": "Notificação da autuação não disponível"
}
GET/v1/traffic-violations/{id}/penalty-notice

Notificação da Penalidade

Retorna o arquivo PDF da notificação da penalidade de uma infração específica.

Parâmetros de Rota

  • Name
    id
    Type
    number
    Required
    obrigatório
    Description

    ID da infração.

Request

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

Response - 200

Content-Type: application/pdf
Content-Disposition: attachment; filename="penalty-notice-{id}.pdf"

[Binary PDF data]

Response - 404

{
  "error": "Infração não encontrada"
}

Response - 404

{
  "error": "Notificação da penalidade não disponível"
}

Essa página foi útil?