Migrer de l'API enedis-v2 vers v0#
L'API v0 est la nouvelle version unifiée de notre API : elle regroupe les intégrations aux différents gestionnaires de réseau (Enedis, GRDF, Strasbourg Électricité Réseaux).
L'ancienne API enedis-v2 (app.switchgrid.tech/enedis/v2) reste disponible jusqu'à fin décembre 2026. Ce guide décrit les changements à effectuer pour migrer.
Les Ask créés avec v0 restent utilisables indifféremment avec les commandes des deux versions. Ceux de /enedis/v2 sont compatibles avec les endpoints v0, et ceux de v0 sont compatibles avec les endpoints enedis-v2.
URL et headers#
/enedis/v2 | v0 | |
|---|---|---|
| Base URL | https://app.switchgrid.tech/enedis/v2 | https://api.switchgrid.tech |
| Header de version | pas de header de version | x-api-version: v0 |
- Nouvelle URL de base :
https://api.switchgrid.tech(au lieu dehttps://app.switchgrid.tech/enedis/v2). - Nouveau header obligatoire :
x-api-version: v0.curl https://api.switchgrid.tech/ask \ -H "Authorization: Bearer <Token>" \ -H "x-api-version: v0" - Les endpoints spécifiques à Enedis sont regroupés sous le préfixe
/integration/enedis. - L'authentification ne change pas (
Authorization: Bearer <Token>), et vos jetons d'API existants restent valables.
Routes déplacées#
Les endpoints spécifiques à Enedis passent sous le préfixe /integration/enedis. Les endpoints de gestion des Ask conservent le même chemin (seules l'URL de base et le header de version changent).
app.switchgrid.tech/enedis/v2 | api.switchgrid.tech - v0 |
|---|---|
POST /ask | inchangé |
GET /ask | inchangé |
GET /ask/{askId} | inchangé |
GET /ask/{askId}/proof | inchangé |
POST /data-third-party | inchangé |
GET /data-third-party | inchangé |
PUT /data-third-party/{slug} | inchangé |
DELETE /data-third-party/{slug} | inchangé |
GET /search_contract | GET /integration/enedis/search_contract |
POST /search_contracts_from_invoices | POST /integration/enedis/search_contracts_from_invoices |
POST /order | POST /integration/enedis/order |
GET /order/{orderId} | GET /integration/enedis/order/{orderId} |
GET /request/{requestId}/data | GET /integration/enedis/request/{requestId}/data |
Nouveaux endpoints en v0#
Quelques endpoints n'existaient pas en enedis-v2 :
- GET
/integration/enedis/contract/{contractId}/details— détails d'un contrat (titulaire, point de livraison, compteurs…). - POST
/ask/{askId}/revoke— révoquer unAsk. - POST
/ask/{askId}/ownership_proof— téléverser un justificatif de contrat (voir section 5).
Spécifications et outils#
La spécification complète de v0 est disponible en ligne (spécification OpenAPI) ainsi qu'au téléchargement :
Upload d'un justificatif lorsque le contrat n'est pas trouvé#
v0 introduit la possibilité de téléverser un justificatif (typiquement une facture d'électricité) lorsqu'un contrat n'a pas pu être trouvé automatiquement via la recherche de contrat (l'Ask est alors en statut NOT_VALID). Cela permet de prouver le lien entre la personne titulaire et le point de livraison, sans bloquer la création de l'Ask.
Le détail du processus (création de l'Ask, téléversement, vérification) est décrit dans le guide v0 — Dépôt de justificatif de contrat.
Statuts Enedis Order#
Les statuts des Orders Enedis ont été légèrement modifiés. Les statuts SUCCESS et SOME_REQUESTS_FAILED ont été remplacés par COMPLETED pour plus de clarté. Pour différencier les Orders entièrement réussies de celles avec des échecs partiels, il faut regarder les statuts individuels des Request associés à l'Order.