Habilitar.me

Indicações

A API de Indicações permite listar e obter detalhes das indicações de condutores para infrações conectadas à sua organização.

Propriedades

  • Name
    id
    Type
    number
    Description

    ID único da indicação.

  • Name
    created_at
    Type
    string
    Description

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

  • Name
    flow
    Type
    enum
    Description

    Fluxo de indicação, definido com base no órgão autuador.

    ValorDescrição
    manualManual (requer preenchimento de formulário).
    automatedAutomático (aceitação simples carteira digital).
  • Name
    status
    Type
    enum
    Description

    Status atual da indicação.

    ValorDescrição
    pendingAguardando ação do condutor indicado.
    acceptedIndicação aceita pelo condutor indicado.
    expiredIndicação expirada por falta de ação do condutor indicado.
    rejectedIndicação rejeitada pelo condutor indicado.
  • Name
    result
    Type
    enum
    Description

    Resultado da indicação com base na avaliação pelo órgão autuador.

    ValorDescrição
    acceptedAceita pelo órgão autuador.
    rejectedRejeitada pelo órgão autuador.
    pendingResultado pendente (em processamento pelo órgão autuador).
  • Name
    processing_status
    Type
    enum
    Description

    Status atual de processamento interno.

    ValorDescrição
    pendingAguardando processamento.
    processedIndicação processada.
    cancelledProcessamento cancelado.
    errorErro de processamento (conferir motivo de erro, na propriedade "processing_result").
  • Name
    signature_status
    Type
    enum
    Description

    Status de assinatura do formulário de indicação.

    ValorDescrição
    signedAssinado.
    unsignedNão assinado.
  • Name
    processing_description
    Type
    string
    Description

    Descrição adicional sobre o processamento interno da indicação.

  • Name
    traffic_violation
    Type
    object
    Description

    Informações da infração relacionada à indicação.

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

      Descrição da infração.

  • Name
    driver
    Type
    object
    Description

    Informações do condutor indicado.

    • Name
      id
      Type
      number
      Description

      ID do condutor.

    • Name
      name
      Type
      string
      Description

      Nome do condutor.

    • Name
      tax_id
      Type
      string
      Description

      CPF do condutor.

    • Name
      external_uid
      Type
      string
      Description

      Identificador externo do condutor.

GET/v1/traffic-violations-indications/

Listar Indicações

Retorna uma lista paginada de todas as indicações de 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].

Parâmetros de Filtro

  • Name
    flow
    Type
    string
    Description

    Filtra por fluxo de indicação.

  • Name
    status
    Type
    string
    Description

    Filtra por status da indicação.

  • Name
    result
    Type
    string
    Description

    Filtra por resultado da indicação.

  • Name
    processing_status
    Type
    string
    Description

    Filtra por status de processamento.

  • Name
    signature_status
    Type
    string
    Description

    Filtra por status de assinatura.

  • Name
    driver_id
    Type
    number
    Description

    Filtra por ID do condutor.

  • Name
    traffic_violation_id
    Type
    number
    Description

    Filtra por ID da infração.

Request

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

Response

{
  "data": [
    {
      "id": 1,
      "created_at": "2024-01-10 14:30:00",
      "flow": "automated",
      "status": "pending",
      "result": "pending",
      "processing_status": "pending",
      "signature_status": "unsigned",
      "processing_description": null,
      "traffic_violation": {
        "id": 123,
        "auto": "R123456789",
        "code": "1234567890",
        "description": "Excesso de velocidade"
      },
      "driver": {
        "id": 456,
        "name": "João da Silva",
        "tax_id": "123.456.789-00",
        "external_uid": "EXT_DRIVER_001"
      }
    },
    {
      "id": 2,
      "created_at": "2024-01-08 10:15:00",
      "flow": "manual",
      "status": "accepted",
      "result": "accepted",
      "processing_status": "processed",
      "signature_status": "signed",
      "processing_description": "Indicação processada com sucesso",
      "traffic_violation": {
        "id": 124,
        "auto": "R987654321",
        "code": "0987654321",
        "description": "Estacionamento irregular"
      },
      "driver": {
        "id": 789,
        "name": "Maria Oliveira",
        "tax_id": "987.654.321-00",
        "external_uid": "EXT_DRIVER_002"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10
  },
  "total": 2
}
GET/v1/traffic-violations-indications/{id}

Detalhar Indicação - id

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

Parâmetros de Rota

  • Name
    id
    Type
    number
    Required
    obrigatório
    Description

    ID da indicação que deseja consultar.

Request

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

Response - 200

{
  "data": {
    "id": 1,
    "created_at": "2024-01-10 14:30:00",
    "flow": "automated",
    "status": "pending",
    "result": "pending",
    "processing_status": "pending",
    "signature_status": "unsigned",
    "processing_description": null,
    "traffic_violation": {
      "id": 123,
      "auto": "R123456789",
      "code": "1234567890",
      "description": "Excesso de velocidade"
    },
    "driver": {
      "id": 456,
      "name": "João da Silva",
      "tax_id": "123.456.789-00",
      "external_uid": "EXT_DRIVER_001"
    }
  }
}

Response - 404

{
  "error": "Indicação não encontrada"
}
POST/v1/traffic-violations-indications/

Criar Indicação

Cria uma ou mais indicações de infrações para um condutor específico.

Parâmetros do Body

  • Name
    traffic_violations
    Type
    array
    Required
    obrigatório
    Description

    Lista de IDs das infrações que serão indicadas. Para indicar uma única infração, envie um array com um elemento. Para múltiplas, envie um array com vários IDs.

  • Name
    driver_id
    Type
    number
    Description

    ID do condutor que será indicado. Se não informado, driver_tax_id é obrigatório.

  • Name
    driver_tax_id
    Type
    string
    Description

    CPF do condutor que será indicado (sem formatação). Se driver_id não for informado, este campo se torna obrigatório para validar a CNH.

É obrigatório informar ou driver_id ou driver_tax_id. Se ambos forem informados, driver_id terá prioridade.

Request

POST
/v1/traffic-violations-indications/
curl -X POST https://api.habilitar.me/v1/traffic-violations-indications/ \
  -H "x-api-key: {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "traffic_violations": [123],
    "driver_id": 456
  }'

Response - 201

{
  "data": [
    {
      "id": 1,
      "created_at": "2024-01-10 14:30:00",
      "flow": "automated",
      "status": "pending",
      "result": "pending",
      "processing_status": "pending",
      "signature_status": "unsigned",
      "processing_description": null,
      "traffic_violation": {
        "id": 123,
        "auto": "R123456789",
        "code": "1234567890",
        "description": "Excesso de velocidade"
      },
      "driver": {
        "id": 456,
        "name": "João da Silva",
        "tax_id": "123.456.789-00",
        "external_uid": "EXT_DRIVER_001"
      }
    },
    {
      "id": 2,
      "created_at": "2024-01-10 14:30:01",
      "flow": "automated",
      "status": "pending",
      "result": "pending",
      "processing_status": "pending",
      "signature_status": "unsigned",
      "processing_description": null,
      "traffic_violation": {
        "id": 124,
        "auto": "R987654321",
        "code": "0987654321",
        "description": "Estacionamento irregular"
      },
      "driver": {
        "id": 456,
        "name": "João da Silva",
        "tax_id": "123.456.789-00",
        "external_uid": "EXT_DRIVER_001"
      }
    }
  ],
  "total": 2
}

Response - 400

{
  "error": "Parâmetro obrigatório ausente",
  "message": "Informe driver_id ou driver_tax_id"
}

Response - 404

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

Formulário de Indicação

Retorna o arquivo PDF do formulário de indicação.

Parâmetros de Rota

  • Name
    id
    Type
    number
    Required
    obrigatório
    Description

    ID da indicação.

Request

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

Response - 200

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

[Binary PDF data]

Response - 404

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

Response - 404

{
  "error": "Formulário de indicação não disponível"
}

Essa página foi útil?