Indicações

A API de Indicações permite listar e criar indicações de condutores para infrações conectadas à sua organização. As indicações são gerenciadas no contexto de uma infração específica.

Propriedades

Name
id
Type
number
Description
ID único da indicação.

Name

status

Type

enum

Description

Status atual da indicação.

Valor	Descrição
`pending`	Aguardando ação do condutor indicado.
`accepted`	Indicação aceita pelo condutor indicado.
`expired`	Indicação expirada por falta de ação do condutor indicado.
`rejected`	Indicação rejeitada pelo condutor indicado.
`failed`	Indicação falhou.
`canceled`	Indicação cancelada.

Name
status_reason
Type
string
Description
Motivo do status da indicação.
Name
tax_id
Type
string
Description
CPF do condutor indicado (11 dígitos).
Name
name
Type
string
Description
Nome do condutor indicado.
Name
flow
Type
enum
Description
Fluxo de indicação.
Valor Descrição
automated Automático (processamento automático).
form Formulário (processamento manual).
Name
email
Type
string
Description
E-mail do condutor indicado.
Name
phone
Type
string
Description
Telefone do condutor indicado.
Name
created_at
Type
string
Description
Data e hora de criação da indicação.
Name
updated_at
Type
string
Description
Data e hora da última atualização da indicação.

Valor	Descrição
`automated`	Automático (processamento automático).
`form`	Formulário (processamento manual).

GET/v1/traffic-violations/{id}/indications

Listar Indicações

Retorna a lista de indicações de condutor para uma infração de trânsito específica.

Parâmetros de Rota

Name
id
Type
number
Required
obrigatório
Description
ID da infração de trânsito.

Request

GET

/v1/traffic-violations/{id}/indications

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

Response - 200

{
  "data": [
    {
      "id": 1,
      "status": "pending",
      "status_reason": null,
      "tax_id": "12345678901",
      "name": "João da Silva",
      "flow": "automated",
      "email": "condutor@email.com",
      "phone": "11999999999",
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T14:45:00.000Z"
    }
  ]
}

Response - 404

{
  "error": "Not Found",
  "message": "Traffic violation with id 123 not found"
}

Eventos de Webhook

Name
traffic-violation.indication.created
Description
Uma nova indicação foi criada.
Name
traffic-violation.indication.updated
Description
Uma indicação foi atualizada.

Exemplo de payload

{
  "type": "traffic-violation.indication.created",
  "data": {
    "id": 1,
    "status": "pending",
    "status_reason": null,
    "tax_id": "12345678901",
    "name": "João da Silva",
    "flow": "automated",
    "email": "condutor@email.com",
    "phone": "11999999999",
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T14:45:00.000Z"
  }
}