Eco-Movement Data API is an outbound API based on the market standard OCPI protocol, which makes it easy for partners and clients to connect with Eco-Movement.
This user guide explains only the main features of OCPI protocol. For more in-depth documentation, refer to the original OCPI 2.1.1 documentation.
Eco-Movement offers a large and growing number of attributes that are not available in the OCPI protocol. These attributes are explained in this documentation.
The fastest and preferred method to receive real-time data from Eco-Movement is to use the PATCH method. Eco-Movement sends the updates to your server without delay using the PATCH method. For this method to work, you are required to build an endpoint that can receive PATCH updates. A so-called handshake can be performed with the
credentials endpoint (/credentials), so that Eco-Movement knows where to send the PATCH updates.
The syntax for the PATCH method is:
The following is an example request using the PATCH method:
The following is an example response:
last_updatedfield is not always available with OCPI 2.1.1.
Eco-Movement emphasizes that the PATCH method (PUSH) is the default and GET requests (PULL) are for minor volumes only. To get real-time information using GET requests, you can use the parameters
date_to. These parameters use the combined date and time format from the ISO 8601 standard. All timestamps are in UTC.
The result returned by Eco-Movement consists only the changes that have occurred during the timeline set using the date_from and date_to parameters. However, it is not completely real-time, because there is an interval of a few minutes between the GET requests. If you desire to have more precise real-time information, it is better to use the PUSH service (PATCH method) of Eco-Movement.
|Use this parameter to set the starting date and time. For example, request only the updates for the last 5 minutes.
|Use this parameter to set the ending date and time. For example, request only the updates for the last 5 minutes.
The following is an example request using the GET method:
When you receive information using GET requests, which often require many paginated requests, if one or more requests fail, retry the failed requests so you don't miss that data.
Eco-Movement strongly recommends limiting simultaneous GET requests to a maximum of 5.
The following table lists the endpoints that are available for communicating using the JSON format:
locations endpoint retrieves a list of all locations or a specific location (using the location's id).
evse endpoint returns a location using the
prices endpoints return a list of MSP prices and CPO ad hoc prices. The prices are considered at the connector level.
tariffs endpoint displays the raw tariffs shared with Eco-Movement by the CPOs using the OCPI protocol.
credentials endpoint performs a so-called handshake between Eco-Movement and your organization.
There are several ways to obtain the data via the OCPI protocol. The preferred method is described below as a recipe. This ensures the fastest real-time data and the least server load for all parties.
Updated 2 days ago