API versie 2.0

Inleiding

U kunt gebruik maken van deze REST API om zelf meetdata te importeren in de Energiemissie applicatie. Heeft u vragen of opmerkingen over de mogelijkheden tot data-ontsluiting of heeft u technische vragen neem dan contact op met [email protected].

Om gebruik te maken van de Inkomende meetdata API moet uw gebruikersaccount voorzien zijn van de juiste rollen en rechten. Neem contact op met onze supportafdeling om dit in te regelen.

Rest

De API maakt gebruik van Representation State Transfer (REST) om gegevens via het web te ontsluiten.

Content-Type: application/json

Voor de uitwisseling van gegevens wordt er gebruikt gemaakt van JSON. De webservice accepteert in een POST request uitsluitend een JSON en geeft altijd een JSON response terug.

Statuscodes

Waar mogelijk wordt gebruikt gemaakt van de juiste HTTP statuscodes. De statuscodes die gehanteerd worden zijn conform de richtlijnen van W3C. De statuscodes die de API hanteert zijn:

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

500 - Internal Server Error

Base URI

De basis-URI van de webservice is als volgt:

https://mijnenergiemissie.nl

Authenticatie
Om gebruik te kunnen maken van de EM webservice v2 dient de api key in de x-api-key header te worden mee gestuurd.

Voorbeeld request met authenticatie

curl -XPOST -H "Content-type: application/json"
            -H "X-API-KEY: xxxxx.apikey"
            https://mijnenergiemissie.nl/webservice/v2/path

Recources

Post measurement

URL

POST /webservice/v2/measurements/messages/em

[
  {
    "ean": "string",
    "channel": "string (DELIVERY|BACKDELIVERY|etc)",
    "value": float (verbruiken),
    "datetime": "ISO 8601 date (2000-01-20T12:00:00+00:00)" 
  },
  ...
]

{
    "id": int,
    "processed": bool,
    "created_at": "ISO 8601 date",
    "updated_at": "ISO 8601 date"
}

GET /webservice/v2/measurements/messages/em/{id}

{
    "id": int,
    "processed": bool,
    "created_at": "ISO 8601 date",
    "updated_at": "ISO 8601 date"
}