Version 2024-01-01
Released
Adds support for Link UI v4, new mobile SDKs and a revamped scopes structure.
This new version supports the new Link UI (v4), the new Link SDKs and introduces revamped scopesAPI and permission flows. For more information about migrating to Link UI v4, please see our migration guide.
Copy linkUpdated device linking endpoint endpoint
Copy linkPayload changes
All experimental and unused fields have been deprecated, and are no longer supported in Link UI v4. For the full payload documentation, refer to the link userAPI endpoint documentation.
| Parameter | Change | Change description |
|---|---|---|
vendorType | Updated | This field is now required. |
forceLanguage | Removed | Deprecated, removed and replaced with language. |
language | Added | A new required field supporting new i18n locales (e.g. en-US and nb-NO), as well as a browser for defaulting to the user’s browser language. |
scopes | Updated | This field is now required, and accepts new values as specified in the new scopes sectionAPI in the API reference. Old scopes have been deprecated and migrated to the new scopes (no re-linking is required). |
redirectUri | Updated | This field is now required, and will return new error and error_message URL parameters if the user exits the Link UI flow before completing. Additionally, about:blank is no longer allowed. Contact us if your app requires this. |
colorScheme | Added | A new optional field for setting the color scheme of Link UI to either light, dark or system (defaults to the user’s operating system color scheme). Defaults to system if not specified. |
username | Removed | This field was deprecated, and has now been removed. |
Copy linkResponse changes
| Parameter | Change | Change description |
|---|---|---|
linkUrl | Updated | Now follows a new URL scheme, and is deployed on link.enode.com. This is used for presenting Link UI via mobile in-app browsers, or web redirects. |
linkState | Removed | This field has been deprecated and removed. |
linkToken | Added | A new field used for initializing the new mobile SDKs for iOS and Android. |
Copy linkUpdated asset API endpoints
As part of the new scopesAPI updates, all asset-related API endpoints now return a scope property with the scopes granted to the asset.
| Endpoint | Change | Change description |
|---|---|---|
GET /batteries | Updated | Asset objects now include a new scopes property. |
GET /chargers | Updated | Asset objects now include a new scopes property. |
GET /hvacs | Updated | Asset objects now include a new scopes property. |
GET /inverters | Updated | Asset objects now include a new scopes property. |
GET /meters | Updated | Asset objects now include a new scopes property. |
GET /vehicles | Updated | Asset objects now include a new scopes property. |
GET /batteries/<assetId> | Updated | Asset objects now include a new scopes property. |
GET /chargers/<assetId> | Updated | Asset objects now include a new scopes property. |
GET /hvacs/<assetId> | Updated | Asset objects now include a new scopes property. |
GET /inverters/<assetId> | Updated | Asset objects now include a new scopes property. |
GET /meters/<assetId> | Updated | Asset objects now include a new scopes property. |
GET /vehicles/<assetId> | Updated | Asset objects now include a new scopes property. |
UPDATE /batteries/<assetId> | Updated | Asset objects now include a new scopes property. |
UPDATE /chargers/<assetId> | Updated | Asset objects now include a new scopes property. |
UPDATE /hvacs/<assetId> | Updated | Asset objects now include a new scopes property. |
UPDATE /inverters/<assetId> | Updated | Asset objects now include a new scopes property. |
UPDATE /meters/<assetId> | Updated | Asset objects now include a new scopes property. |
UPDATE /vehicles/<assetId> | Updated | Asset objects now include a new scopes property. |
Pass 2024-01-01 as your version header to use this new version.