BURKINA FASO · Direction Santé Communautaire

Documentation API publique PGA

Accès aux statistiques agrégées de la Plateforme de Gestion des ASBC.
Version v1 · Données anonymisées · Usage réservé aux partenaires institutionnels.

Table des matières

1. Authentification
2. Rate limiting
3. Scopes disponibles
4. Endpoints
5. Codes d'erreur

1. Authentification

Chaque requête nécessite un token Bearer obtenu auprès de l'administrateur PGA.

GET /api/v1/public/status HTTP/1.1
Host: pga-plateforme.com
Authorization: Bearer pga_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Alternative : header X-PGA-API-Key :

curl -H "X-PGA-API-Key: pga_xxx..." https://pga-plateforme.com/api/v1/public/status

⚠ Sécurité : Ne pas exposer votre token dans un dépôt public ou côté client. Les tokens compromis doivent être révoqués immédiatement.

2. Rate limiting

Chaque clé a un quota horaire (1 000 requêtes par défaut). Les réponses incluent :

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 985
X-API-Partner: UNICEF Burkina Faso

Dépassement → réponse 429 Too Many Requests avec un header Retry-After.

3. Scopes disponibles

Scope	Description
`stats:fonctionnalite`	Taux de fonctionnalité agrégés par région/province/district
`stats:paiements`	Paiements mensuels (volumes et montants agrégés)
`stats:cnib`	Alertes CNIB (compteurs anonymisés par région)
`stats:equipements`	Couverture et ruptures d'équipements traceurs
`stats:geographie`	Couverture géographique (districts, formations, villages, ASBC)

4. Endpoints

GET /api/v1/public/status

Vérification de l'état du service (aucun scope requis).

{
  "status": "ok",
  "service": "PGA Open Data API",
  "version": "v1",
  "pays": "Burkina Faso",
  "time": "2026-04-18T12:34:56+00:00"
}

GET /api/v1/public/stats/fonctionnalite stats:fonctionnalite

Taux de fonctionnalité des ASBC pour une période, agrégés par zone.

Paramètres

Nom	Type	Requis	Description
periode	string	oui	Format `YYYY-MM` (ex: `2026-03`)
niveau	enum	non	`region` (défaut), `province`, `district`

Exemple de réponse

{
  "periode": "2026-03",
  "niveau": "region",
  "data": [
    {
      "zone": "Boucle du Mouhoun",
      "total_asbc": 2143,
      "nb_fonctionnels": 1685,
      "nb_non_fonctionnels": 341,
      "taux_fonctionnalite": 78.63
    },
    ...
  ]
}

GET /api/v1/public/stats/paiements stats:paiements

Volumes et montants de paiements Orange Money pour une période.

Paramètres

Nom	Type	Requis	Description
periode	string	oui	Format `YYYY-MM`

Exemple de réponse

{
  "periode": "2026-03",
  "devise": "FCFA",
  "par_statut": {
    "reussi":     { "nombre": 14230, "montant_total": 28460000 },
    "echec":      { "nombre": 285,   "montant_total": null },
    "rembourse":  { "nombre": 12,    "montant_total": null },
    "en_attente": { "nombre": 0,     "montant_total": null }
  },
  "total": 14527,
  "montant_verse": 28460000
}

GET /api/v1/public/stats/cnib stats:cnib

Compteurs des CNIB à surveiller (expirés, à renouveler, manquants) par région.

Exemple de réponse

{
  "date_calcul": "2026-04-18",
  "seuil_renouvellement_mois": 3,
  "par_region": [
    {
      "region": "Centre",
      "total_asbc": 1847,
      "nb_expires": 43,
      "nb_a_expirer": 187,
      "nb_sans_cnib": 22
    },
    ...
  ]
}

GET /api/v1/public/stats/equipements stats:equipements

Taux de couverture et de rupture pour chaque item du kit traceur ASBC.

GET /api/v1/public/stats/geographie stats:geographie

Structure géographique et couverture (nombre de districts, formations, villages, ASBC par région).

Exemple de réponse

{
  "date_calcul": "2026-04-18",
  "pays": "Burkina Faso",
  "totaux": {
    "nb_regions": 13,
    "nb_districts": 70,
    "nb_formations_sanitaires": 2248,
    "nb_villages": 8897,
    "nb_asbc_actifs": 15821
  },
  "par_region": [...]
}

5. Codes d'erreur

Code HTTP	Signification
`200`	Succès
`401`	Token manquant, invalide, révoqué ou expiré
`403`	Scope non autorisé pour cette clé
`422`	Paramètres de requête invalides
`429`	Limite de requêtes dépassée — voir `Retry-After`
`5xx`	Erreur serveur — contacter l'administrateur PGA

📧 Support : Pour obtenir un token ou signaler un problème, contactez l'équipe DSC : admin@pga-plateforme.com

PGA · Plateforme de Gestion des ASBC · Ministère de la Santé · Burkina Faso