Technical details inbound API version 1.0 (outdated version)

The inbound API is made for chargingpoint operators to insert and update their charging points in the database of Eco-Movement. The outbound API is implemented own your own server. Eco-Movement will automatically fetch the information from this server. To start using the inbound API of Eco-Movement you first have to request a developer key.

After you have implemented the interface, it is possible to do tests in the testing environment. After a succesfull test cycle we will be able to see this in our backoffice system. On your request we can switch your inbound API to LIVE mode. While in LIVE mode the database will refresh every 24 hours.

Eco-Movement supports a REST API, a simple to use interface, witch is much more easier to use then the more complex SOAP interfaces. Eco-Movement uses JSON format for the inbound API, all the data needs to be in the JSON format.


The API interfaces that needs to be implemented:

GetChargingpoints

Provides information about all charging stations.
REST: GET [GetChargingpoints url]  – You can define your own url.
Requested by Eco-Movement: 1 time a day.
Eco-Movement will fetch the information from your own server.


GetChargingpoints

example:

http://www.yourdomain.com/api/getchargingpoints

 

If you don’t want that your endpoint will be public you are free to use a key. You are free to define your own url. For example:

http://database.yourdomain.com/ourchargingpoints/getourpoints?secret=CF78AB669013478DE6F

 

Result

The result (in JSON) will be in the following format:

result ::= [ <laadpaal>,<laadpaal>… ]
laadpaal ::= { <lpkeyvalue>,<lpkeyvalue>…  }
lpkeyvalue ::=  “<lpkey>”:<value>
lpkey ::= id | lng | lat | owner | name | address | postalcode | city | country | phone | url | owner | email |  opentimes | chargetype | connectortype | nroutlets | cards | pricemethod | price | power | vehicle | facilities | realtimestatus
value ::= “string” | number | true | false | {object} | [array]
id = primary key (string).
    • This value will be used for adjustments of a specific chargingpoint. A new id will create a new charging point. The same id will update the existing charging point.
lng = decimal longitude (decimal)
    • Example:  3.1415927
lat = decimal latitude (decimal)  
    • example 5.6789
owner = owner of the charging point (string)  (optioneel)
    • If you leave this empty the name of the company will be used as default
manager = maintenance party of the charging point (string)  (optioneel)
    • If you leave this empty the ‘owner’ will be used as ‘manager’
name = name of the charging point  (string)
    • This is the name that will be used on the website
address = adres, including housenumber (string)
postalcode = postalcode (string)
city = city (string)
country =  country code (string)
    • 2 character ISO3166 country code, example. “NL”
phone = phone service for enduser (string)
    • Attention! The following format is required: “+(country code)-(area code without zero)-phonenumber”. Example: “+(31)-(123)-1234567”
url = information url of charging point (string)
email = information email address of owner (string)
chargetype (string) (set of fixed values)
    • “DC snellader”,”DC semisnel”,”AC krachtstroom”,”AC simpel”
connectortype (string) (set of fixed values)
    •  “chademo”,”J1772″,”mennekes”,”CEE”,”CEEblauw”,”schuko”
nroutlets = number of outlets on the charging point (numeric)
    • Attention! For charging points with more than one plugs with different properties you need to split these charging points into more records, every record needs to have a different id and nroutlets=1.
cards = only valid cards (array with valid cards)
    • “elaad”, “thenewmotion”, “essent”, “essentsnellaad”, “eneco”, “nuon”, “contant”, “travelcard”, “total”, “alfen”, “mrgreen”, “chargepnt”, “evbox”, “grwheel”, “evtaxi”, “evpoint”, “anwb”, “greenflux”,”bluecorner”,”gratis”
pricemethod = the way the payment is made
    •  “per kWh”,”per laadbeurt”,”per 10min”, “jaarabonnement”, “maandabonnement”, “eenmalig”,  “onbekend”, “afhankelijk van pas”, “gratis”
price = price in EURO (decimal)
opentimes = openingstijden (array of string)
    • String: Explanation of opening times. example: “na 18:00 gesloten”
    • Array: Formal list, the elements can have the following values:
      • weekday: string. possible values: “ma-vr”,”ma-zo”,”za-zo”,”ma”,”di”,”wo”,”do”,”vr”,”za”,”zo”
      • open: string time format hh:mm
      • close: string time format hh:mm
images = photo url or list of photo url’s of the object (array or string) (optional)
power  (string) (fixed value)
    •  “2,3kW”,”3,7kW”,”5kW”,”11kW”,”20kW”,”22kW”,”43kW”,”50kW”
vehicle
    • “auto”,”fietsscooter”,”alle”
facilities (array with facilities around the charging point)
    • ‘wifi’,’wc’,’parkeer’,’restaurant’,’werkplek’,’wachtruimte’,’koffiecorner’,’shop’,’winkelcentrum’,’openbaar vervoer’
realtimestatus = true/false 
    • False –  The charging point gets the status “unknown”
    • True – The charging point gets the status “available”.
      Through the SetAvailability call the availability can be updated realtime

 

Example:

 [{  "id":"5814",
     "lng":"5.08515",
     "lat":"51.99005",
     "owner":"NewMotion",
     "name":"NewMotion NL-TNM-FC12",
     "address":"Prins Bernardstraat 75",
     "postalcode":"4132 XE",
     "city":"Vianen",
     "country":"NL",
     "phone":"020 662 9992",
     "url":"http:\/\/thenewmotion.com",
     "email":"",
     "opentimes":null,
     "chargetype":"DC snellader",
     "connectortype":"chademo",
     "nroutlets":"1",
     "cards":["thenewmotion","essent"],
     "pricemethod":"per laadbeurt",
     "price":null,
     "power":"50kW",
     "vehicle":"auto",
     "facilities":["wifi","wc","parkeer","restaurant","werkplek","koffiecorner"],
     "opentimes":[
          { "weekday":"ma-vr","open":"06:00", "close": "18:00"},
          { "weekday":"za-zo","open":"09:00","close":"17:00"}
     ],
     "images":[
        "http://mywebsite.com/images/455.jpg",
        "http://mywebsite.com/images/3444.jpg"
     ],
     "realtimestatus":false
},
{    "id": 7788,
     ...
},
... ]