Skip to content

Alertes

Endpoints pour la gestion des alertes de risque.

GET /alerts

Liste paginée des alertes.

Request:

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

Query Parameters:

  • page (int, défaut: 1) - Numéro de page
  • size (int, défaut: 20) - Éléments par page
  • status (string) - Filtre par statut (open, under_investigation, resolved, dismissed)
  • severity (string) - Filtre par sévérité (low, medium, high, critical)

Exemple:

bash
curl "https://api.gbfiscalai.srv1164291.hstgr.cloud/api/v1/alerts?status=open" \
  -H "Authorization: Bearer <token>"

Réponse:

json
{
  "items": [
    {
      "id": 1,
      "title": "Sous-évaluation détectée",
      "description": "Valeur déclarée inférieure au prix de référence",
      "alert_type": "anomaly",
      "severity": "critical",
      "status": "open",
      "declaration_id": 42,
      "created_at": "2026-01-12T10:00:00Z"
    }
  ],
  "total": 25,
  "page": 1,
  "size": 20,
  "pages": 2
}

GET /alerts/id

Détails d'une alerte spécifique.

Request:

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

Réponse:

json
{
  "id": 1,
  "title": "Sous-évaluation détectée",
  "severity": "critical",
  "status": "open",
  "declaration": {
    "id": 42,
    "reference": "DEC-2026-00042"
  },
  "created_at": "2026-01-12T10:00:00Z"
}

PATCH /alerts/id

Met à jour le statut d'une alerte.

Request:

bash
PATCH /api/v1/alerts/1
Authorization: Bearer <token>
Content-Type: application/json

Body:

json
{
  "status": "resolved",
  "resolution_notes": "Vérification effectuée"
}

Réponse:

json
{
  "id": 1,
  "status": "resolved",
  "resolved_at": "2026-01-12T15:00:00Z"
}

Types d'Alertes

  • anomaly - Anomalie de valeur détectée
  • document - Document manquant ou suspect
  • pattern - Pattern comportemental suspect
  • fraud - Fraude potentielle

Schéma Alert

typescript
interface Alert {
  id: number
  title: string
  description: string
  alert_type: string
  severity: string
  status: string
  declaration_id: number
  created_at: string
  updated_at: string
}

Ministere des Finances - Guinee-Bissau