Version 2023-08-01
Released
Clients can now list all their vehicles, chargers and other assets using paginated resources.
1. Breaking Changes
Endpoints:
Endpoint | Description |
---|---|
/vehicles | List all client vehicles, paginated. |
/chargers | List all client chargers, paginated. |
/hvacs | List all client HVAC units, paginated. |
/inverters | List all client inverters, paginated. |
/me | Removed. Moved to /users/{userId} . |
/charging-locations/* | Removed. Replaced by /locations . |
Headers:
- Remove
Enode-User-Id
header. Requests with this header will fail.
Hierarchy Changes:
- Introduced
/users
as the top level for user-related resources due to change in authentication strategy.
Other Changes:
- Began renaming
chargingLocationId
tolocationId
across endpoints. Remove it entirely fromTemperature Schedule
. - Remove
field
from all asset types. Instead, you can now use<assets>/{assetId}/refresh-hint
to initiate an accelerated data refresh, ie:/vehicles/{vehicleId}/refresh-hint
. /statistics/charging
- Fields
smartSession
andnonSmartCostSum
have been removed. - For non-smart charging,
estimatedSavings
is set tonull
.
- Fields
/statistics/charging/sessions
- Fields
smartSession
andsmartStats.nonSmartCostSum
have been removed. - The
smartStats
object has been removed. - The fields
estimatedSavings
andnonSmartPrice
now appear at top level. - For non-smart charging sessions,
estimatedSavings
is set tonull
.
- Fields
- Legacy user access tokens are no longer supported on client-scoped resources. If your existing integration calls Enode with per-user access tokens, you should switch to using client credentialsAPI as part of upgrading to
2023-08-01
.
2. Removed Endpoints
Endpoint | Replacement |
---|---|
GET /me | GET /users/{userId} |
DELETE /me/vendors/{vendor} | DELETE /users/{userId}/vendor/{vendor} |
/charging-locations/* | /locations/* |
/statistics/* | /users/{userId}/statistics/* |
GET /schedules | GET /users/{userId}/schedules |
POST /schedules | POST /users/{userId}/schedules |
3. New Endpoints
New Endpoint | Description |
---|---|
GET /users | List all client users (paginated) |
GET /users/{userId}/vendor/{vendor} | Vendor details |
GET /users/{userId}/vehicles | List all user vehicles (paginated) |
GET /users/{userId}/chargers | List all user chargers (paginated) |
GET /users/{userId}/hvacs | List all user HVAC units (paginated) |
GET /users/{userId}/inverters | List all user inverters (paginated) |
/users/{userId}/statistics/* | All statistic endpoints are moved behind /users/{userId}/ |
GET /users/{userId}/schedules | List all user schedules (paginated) |
POST /users/{userId}/schedules | Create a schedule for the user |
POST <assets>/{assetId}/refresh-hint | Initiate an accelerated data refresh. |
4. Pagination
We have introduced cursor-based pagination for all endpoints that return a list of resources. Reference: Pagination StrategyAPI
Pass 2023-08-01
as your version header to use this new version.