Une passerelle standardisée pour connecter votre application aux compteurs.
Que vous soyez Ă©diteur de logiciel, acteur de la gestion technique du bĂątiment, agrĂ©gateur dâĂ©nergie ou intĂ©grateur domotique, Capfile API vous permet dâautomatiser la rĂ©cupĂ©ration, le suivi et lâintĂ©gration des donnĂ©es de consommation, dâindex et de courbe de charge.
đ Fonctions principales
- â
Initier lâaccĂšs aux donnĂ©es dâun compteur (avec consentement utilisateur)
- â
Suivre lâavancement de la demande
- â
RĂ©cupĂ©rer les donnĂ©es une fois lâaccĂšs validĂ©
- â
Recevoir automatiquement les mises à jour via un webhook sécurisé
𧰠API RESTful basée sur OpenAPI 3.0
- Format : JSON
- Méthodes supportées :
GET, POST, PUT
- Authentification :
Basic, Bearer Token, ou API Key
- Documentation complĂšte au format OpenAPI (Swagger UI)
đ Exemples de cas dâusage
| Objectif | Endpoint utilisé |
|---|
| Initier un accÚs aux données | POST /v1/access/init |
| Suivre lâavancement | GET /v1/access/{accessKey}/status |
| Récupérer la courbe de charge | GET /v1/access/{accessKey}/loadcurve |
| Lire les index journaliers | GET /v1/prm/{prm}/indexes |
| Obtenir les infos techniques dâun compteur | GET /v1/prm/{prm}/info |
| Configurer un webhook | PUT /v1/config/webhook |
đ Webhook sĂ©curisĂ©
- Transmission en HTTPS POST
- Signature HMAC SHA-256 dans lâen-tĂȘte
X-Signature
- Données incluses :
access_key, PRM, type de mise à jour (loadcurve, indexes, etc.), période
- Vérification de la signature cÎté serveur recommandée
đ§ Authentification flexible
| Méthode | Détail |
|---|
| BasicAuth | identifiant + mot de passe |
| Bearer Token | via POST /v1/login |
| API Key | dans lâen-tĂȘte X-API-KEY |
đ Endpoints principaux
| Méthode | URL | Description |
|---|
POST | /v1/access/init | CrĂ©er une demande dâaccĂšs |
GET | /v1/access/{accessKey}/data | Lire toutes les données |
GET | /v1/access/{accessKey}/indexes | Lire les index |
GET | /v1/prm/{prm}/loadcurve | Courbe de charge par PRM |
PUT | /v1/config/webhook | Configuration du webhook |
POST | /v1/login | Authentification API |
đšâđ» Pour qui ?
- Développeurs intégrant les données Enedis dans un outil métier
- Collectivités ou agriculteurs souhaitant automatiser la collecte de données pour leurs exploitations
- Plateformes dâanalyse, dâoptimisation ou de facturation Ă©nergĂ©tique
đ [Demander une clĂ© API]