Authentification
Tous les appels sont effectués avec un header d'authentification Authorization: Bearer <Token>. Les tokens peuvent être créés et renouvelés via l'interface https://app.switchgrid.tech.
Toutes les requêtes doivent inclure le header x-api-version: v0 pour cibler cette version de l'API.
curl https://api.switchgrid.tech/ask \
-H "Authorization: Bearer <Token>" \
-H "x-api-version: v0"
Attention, ce token API est un secret. Il permet de demander des données de consommation Enedis. Il est donc conseillé de ne pas le divulguer, et donc de faire les appels API depuis un serveur, et non depuis le navigateur ou un client mobile.
Environnement de test : header switchgrid-test-env
Le header switchgrid-test-env choisit l'environnement de l'appel. Il est facultatif :
| Valeur du header | Environnement | Effet |
|---|---|---|
true | Test | Aucun gestionnaire de réseau (Enedis, GRDF, ESR…) n'est appelé, rien n'est facturé, les données renvoyées sont fictives. |
false, ou header absent | Production | Les gestionnaires de réseau sont réellement appelés, l'appel est facturé, les données renvoyées sont réelles. |
Envoyer false revient exactement à ne pas envoyer le header : pour passer en production, il suffit de le retirer.
Les deux environnements sont cloisonnés. Un Ask créé avec switchgrid-test-env: true est un Ask de test, et tous les appels qui le concernent (liste des Asks, commande de données, révocation) doivent aussi porter switchgrid-test-env: true. Sans le header, ces appels ne voient que les Asks et consentements de production : un Ask de test n'apparaît pas dans GET/ask, et commander des données dessus ou le révoquer renvoie une 404. L'inverse est vrai pour un Ask de production appelé avec le header à true. Un Ask de test ne peut donc pas « passer » en production : recréez-le sans le header.
Le header est ignoré par /search_contract, qui interroge toujours les gestionnaires de réseau réels. Le détail du parcours de test (PRM, PCE et RTPL de test) est dans Tester la création d'un Ask.