Endpoints de Alertas

Alertas são notificações geradas pelo sistema para informar sobre eventos importantes relacionados aos pontos de controle.

Todos os endpoints requerem autenticação.

Authorization: Bearer <token>

---

Objeto Alert

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "control_point_id": "cp-uuid",
  "type": "POWER_FAILURE",
  "message": "Falha de energia detectada no ponto de controle",
  "status": "ACTIVE",
  "triggered_at": "2025-11-21T10:30:00Z",
  "resolved_at": null
}

---

Tipos de Alerta

Tipo	Descrição
POWER_FAILURE	Falha de energia detectada
LOW_OXYGEN / OD_LOW	Oxigênio dissolvido baixo
HIGH_TEMPERATURE	Temperatura alta
DEVICE_OFFLINE	Dispositivo offline

Status do Alerta

Status	Descrição
ACTIVE	Alerta está ativo
RESOLVED	Alerta foi resolvido

---

GET /alerts/

Lista alertas ativos para os pontos de controle do usuário.

Requisição

GET /api/v1/alerts/
Authorization: Bearer <token>

Resposta 200 OK

[
  {
    "id": "alert-uuid-1",
    "control_point_id": "cp-uuid",
    "type": "POWER_FAILURE",
    "message": "Falha de energia detectada no ponto de controle",
    "status": "ACTIVE",
    "triggered_at": "2025-11-21T10:30:00Z",
    "resolved_at": null
  },
  {
    "id": "alert-uuid-2",
    "control_point_id": "cp-uuid-2",
    "type": "DEVICE_OFFLINE",
    "message": "Dispositivo CP-002 está offline",
    "status": "ACTIVE",
    "triggered_at": "2025-11-21T11:00:00Z",
    "resolved_at": null
  }
]

---

POST /alerts/{control_point_id}/alerts

Cria um alerta para um ponto de controle.

Parâmetros de URL

Parâmetro	Tipo	Descrição
control_point_id	UUID	ID do ponto de controle

Requisição

POST /api/v1/alerts/cp-uuid/alerts
Authorization: Bearer <token>
Content-Type: application/json

{
  "type": "POWER_FAILURE",
  "message": "Falha de energia detectada no ponto de controle"
}

Parâmetros do Body

Campo	Tipo	Obrigatório	Descrição
type	enum	✅	Tipo do alerta
message	string	✅	Mensagem descritiva

Resposta 201 Created

{
  "id": "alert-uuid",
  "control_point_id": "cp-uuid",
  "type": "POWER_FAILURE",
  "message": "Falha de energia detectada no ponto de controle",
  "status": "ACTIVE",
  "triggered_at": "2025-11-21T10:30:00Z",
  "resolved_at": null
}

Nota

A criação de alertas é registrada automaticamente nos logs do sistema.

Possíveis Erros

Status	Detalhe
404	Ponto de controle não encontrado
403	Sem permissão para criar alerta neste ponto de controle

---

PUT /alerts/{alert_id}/resolve

Marca um alerta como resolvido.

Parâmetros de URL

Parâmetro	Tipo	Descrição
alert_id	UUID	ID do alerta

Requisição

PUT /api/v1/alerts/alert-uuid/resolve
Authorization: Bearer <token>

Resposta 200 OK

{
  "id": "alert-uuid",
  "control_point_id": "cp-uuid",
  "type": "POWER_FAILURE",
  "message": "Falha de energia detectada no ponto de controle",
  "status": "RESOLVED",
  "triggered_at": "2025-11-21T10:30:00Z",
  "resolved_at": "2025-11-21T12:00:00Z"
}

Nota

A resolução de alertas é registrada automaticamente nos logs do sistema.

Possíveis Erros

Status	Detalhe
404	Alerta não encontrado
403	Sem permissão para resolver este alerta

---

Boas Práticas

Monitoramento de Alertas

1. Verifique alertas regularmente - Configure uma rotina para verificar alertas ativos
2. Resolva alertas prontamente - Marque como resolvido após tomar ação
3. Documente ações - Mantenha registro das ações tomadas para cada alerta

Cuidado

Alertas críticos como POWER_FAILURE ou LOW_OXYGEN devem ser tratados imediatamente para evitar perdas na produção.