⬆ Support v5 of the RTE API

kamaradclimber · kamaradclimber · commit caa957f07d7c · 2023-11-11T19:37:48.000+01:00
We try v5 first and fallback to v4 if we receive a 403. There is apparently no way to know if an api key has been generated for v5 or v4 but they are incompatible. Only way to know is to test. Fix #68 Fix #67
diff --git a/README.en.md b/README.en.md
@@ -14,7 +14,7 @@ Use [hacs](https://hacs.xyz/).
 ### Get api access for RTE APIs
 
 - Create an account on [RTE API website](https://data.rte-france.com/web/guest)
-- Register to the [Ecowatt API](https://data.rte-france.com/catalog/-/api/consumption/Ecowatt/v4.0) and click on "Abonnez-vous &agrave; l'API", create a new application
+- Register to the [Ecowatt API](https://data.rte-france.com/catalog/-/api/consumption/Ecowatt/v5.0) and click on "Abonnez-vous &agrave; l'API", create a new application
 - get the `client_id` and `client_secret` (uuid in both cases)
 
 ### Configure home-assistant
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ Utilisez [hacs](https://hacs.xyz/).
 ### Obtenir un acc&egrave;s API pour les API RTE
 
 - Cr&eacute;er un compte sur [site API RTE](https://data.rte-france.com/web/guest)
-- Inscrivez-vous &agrave; l'[API Ecowatt](https://data.rte-france.com/catalog/-/api/consumption/Ecowatt/v4.0) et cliquez sur "Abonnez-vous &agrave; l'API", cr&eacute;ez un nouvelle application
+- Inscrivez-vous &agrave; l'[API Ecowatt](https://data.rte-france.com/catalog/-/api/consumption/Ecowatt/v5.0) et cliquez sur "Abonnez-vous &agrave; l'API", cr&eacute;ez un nouvelle application
 - obtenir le `client_id` et `client_secret` (uuid dans les deux cas)
 
 ### Configurer home-assistant
diff --git a/custom_components/rte_ecowatt/__init__.py b/custom_components/rte_ecowatt/__init__.py
@@ -122,6 +122,7 @@ def __init__(self, hass, config: ConfigType):
         self.config = config
         self.hass = hass
         self.oauth_client = AsyncOauthClient(config)
+        self.api_version = "v5"
 
     async def async_oauth_client(self):
         client = await self.oauth_client.client()
@@ -176,11 +177,23 @@ async def update_method(self):
             headers = {
                 "Authorization": f"{self.token['token_type']} {self.token['access_token']}"
             }
-            url = f"{BASE_URL}/open_api/ecowatt/v4/signals"
+            url = f"{BASE_URL}/open_api/ecowatt/{self.api_version}/signals"
             if "ECOWATT_DEBUG" in os.environ:
-                url = f"{BASE_URL}/open_api/ecowatt/v4/sandbox/signals"
+                url = f"{BASE_URL}/open_api/ecowatt/{self.api_version}/sandbox/signals"
             api_result = await client.get(url, headers=headers)
             _LOGGER.info(f"data received, status code: {api_result.status}")
+            if api_result.status == 403:
+                # a code 403 is likely to be an api key from a previous version of the api
+                if self.api_version == "v5":
+                    _LOGGER.warn(
+                        f"Received a 403, api key is likely from a previous version, downgrading to api v4. You can regenerate a new api key to avoid this warning"
+                    )
+                    self.api_version = "v4"
+                    return await self.update_method()
+                else:
+                    raise UpdateFailed(
+                        f"Error communicating with RTE API: received a 403 from api, even with version {self.api_version}"
+                    )
             if api_result.status == 429:
                 # a code 429 is expected when requesting more often than every 15minutes and not using the sandbox url
                 # FIXME(kamaradclimber): avoid this error when home assistant is restarting by storing state and last update
@@ -225,7 +238,9 @@ async def async_added_to_hass(self):
             ):
                 _LOGGER.debug(f"Restoring state for {self.unique_id}")
                 self._attr_native_value = extra_stored_data.native_value
-                self._attr_native_unit_of_measurement = extra_stored_data.native_unit_of_measurement
+                self._attr_native_unit_of_measurement = (
+                    extra_stored_data.native_unit_of_measurement
+                )
                 # sadly it seems as of 2023.6 we don't have any way to get back the additional attributes
                 self.coordinator.last_update_success = True
             else:

-Original file line number
+Diff line change
 ### Obtenir un accès API pour les API RTE
 - Créer un compte sur [site API RTE](https://data.rte-france.com/web/guest)
 -- Inscrivez-vous à l'[API Ecowatt](https://data.rte-france.com/catalog/-/api/consumption/Ecowatt/v4.0) et cliquez sur "Abonnez-vous à l'API", créez un nouvelle application
 +- Inscrivez-vous à l'[API Ecowatt](https://data.rte-france.com/catalog/-/api/consumption/Ecowatt/v5.0) et cliquez sur "Abonnez-vous à l'API", créez un nouvelle application
 - obtenir le `client_id` et `client_secret` (uuid dans les deux cas)
 ### Configurer home-assistant