API publique
Les données de Consom'Action dans vos applications
Une API JSON en lecture seule : résultats agrégés, baromètres et scores de confiance, indices, catalogue des données ouvertes. Gratuite, sans inscription pour un usage modéré.
Démarrer
Toutes les routes répondent en JSON (clés en anglais) aux requêtes GET. Les libellés sont en français par défaut ; ajoutez ?lang=en ou l'en-tête Accept-Language: en pour l'anglais.
curl "https://dev.consomaction.bf/api/v1/results?lang=en"
curl -H "Authorization: Bearer VOTRE_CLE" "https://dev.consomaction.bf/api/v1/barometers"Adresse de base : https://dev.consomaction.bf/api/v1
Description OpenAPI 3.1 : https://dev.consomaction.bf/api/v1/openapi.json
Routes disponibles
| Méthode | Chemin | Description |
|---|---|---|
| GET | /api/v1/meta | Licence, version, contact, dernière mise à jour, calendrier des prochaines publications. |
| GET | /api/v1/themes | Thématiques et nombre de contenus publics. |
| GET | /api/v1/surveys | Sondages ouverts au public (titre, thème, durée, nombre de questions et de participants, lien). |
| GET | /api/v1/results | Résultats publiés (provisoires ou définitifs) ; filtres theme, from, to, status. |
| GET | /api/v1/results/{slug} | Résultat complet : méthodologie, questions publiées, distributions et statistiques. |
| GET | /api/v1/results/{slug}/questions/{code} | Une question publiée et sa distribution. |
| GET | /api/v1/barometers | Baromètres publics. |
| GET | /api/v1/barometers/{slug} | Vagues, évolution des questions récurrentes, scores de confiance par opérateur. |
| GET | /api/v1/indices | Indices publiés ; filtres code, geography, from, to. |
| GET | /api/v1/datasets | Catalogue des données ouvertes ; filtres theme, source_type, from, to. |
| GET | /api/v1/datasets/{slug} | Fiche d'un jeu : licence, formats et liens de téléchargement, méthodologie, citation. |
Conventions
- Pagination : paramètres page et per_page (100 au plus) ; réponse avec data, links et meta.
- Dates au format ISO 8601 ; filtres from et to au format AAAA-MM-JJ.
- Identifiants publics uniquement : uuid et slug. Aucun identifiant interne.
- Agrégats uniquement : aucune réponse individuelle ; participations de test et réponses écartées exclues.
- Cache HTTP : Cache-Control public de 10 minutes et ETag (réponse 304 si If-None-Match correspond).
- CORS ouvert en lecture (GET) : appel possible depuis un navigateur.
- Erreurs : 404 { "error": { "code": "not_found" } }, 401 clé invalide, 422 paramètre invalide, 429 quota dépassé (en-tête Retry-After).
Quotas
Sans clé : 60 requêtes par minute et par adresse IP. Avec une clé : 600 requêtes par minute (quota ajustable). Au-delà, l'API répond 429.