Enode Developers
Latest version

Select version to view

About API versions

Changelog

RSS

Keep track of updates and new API versions. More on versioning here.

See all updates

Version 2023-08-01

Released

Clients can now list all their vehicles, chargers and other assets using paginated resources.

1. Breaking Changes

Endpoints:

EndpointDescription
/vehiclesList all client vehicles, paginated.
/chargersList all client chargers, paginated.
/hvacsList all client HVAC units, paginated.
/invertersList all client inverters, paginated.
/meRemoved. 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 to locationId across endpoints. Remove it entirely from Temperature 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 and nonSmartCostSum have been removed.
    • For non-smart charging, estimatedSavings is set to null.
  • /statistics/charging/sessions
    • Fields smartSession and smartStats.nonSmartCostSum have been removed.
    • The smartStats object has been removed.
    • The fields estimatedSavings and nonSmartPrice now appear at top level.
    • For non-smart charging sessions, estimatedSavings is set to null.
  • 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

EndpointReplacement
GET /meGET /users/{userId}
DELETE /me/vendors/{vendor}DELETE /users/{userId}/vendor/{vendor}
/charging-locations/*/locations/*
/statistics/*/users/{userId}/statistics/*
GET /schedulesGET /users/{userId}/schedules
POST /schedulesPOST /users/{userId}/schedules

3. New Endpoints

New EndpointDescription
GET /usersList all client users (paginated)
GET /users/{userId}/vendor/{vendor}Vendor details
GET /users/{userId}/vehiclesList all user vehicles (paginated)
GET /users/{userId}/chargersList all user chargers (paginated)
GET /users/{userId}/hvacsList all user HVAC units (paginated)
GET /users/{userId}/invertersList all user inverters (paginated)
/users/{userId}/statistics/*All statistic endpoints are moved behind /users/{userId}/
GET /users/{userId}/schedulesList all user schedules (paginated)
POST /users/{userId}/schedulesCreate a schedule for the user
POST <assets>/{assetId}/refresh-hintInitiate 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.