Overslaan naar inhoud
Nederlands
Klantenportaal Inloggen
Neem contact met ons op
  • Er zijn geen suggesties want het zoekveld is leeg.

Inkomende meetdata API (EM v2.0)

Inhoudsopgave
De inhoudsopgave wordt geladen...

Inleiding

U kunt gebruik maken van deze REST API om zelf meetdata te importeren in de Energiemissie applicatie. De API maakt gebruik van Representation State Transfer (REST) om gegevens via het web te ontsluiten. 

Om gebruik te maken van de Inkomende meetdata API moet uw gebruikersaccount voorzien zijn van de juiste rollen en rechten.

  • Neem hiervoor contact op met de servicedesk van Energiemissie.

Heb je andere vragen of opmerkingen over de mogelijkheden tot data-ontsluiting of andere technische vragen, ook dan kan je terecht bij de servicedesk via support@energiemissie.nl.

Fair use policy

De API wordt beschikbaar gesteld op basis van een ‘fair use’ policy. Bij overmatig gebruik, bijvoorbeeld door in korte tijd meerdere malen de totale historie opnieuw binnen te halen, kunnen wij kosten in rekening brengen of uw account tijdelijk- of geheel intrekken.

Standaardinformatie

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 URL

De basis-URI van de webservice is als volgt: https://mijnenergiemissie.nl

Authenticatien

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

Voorbeeldrequest met authenticatie:

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

De instructie voor het aanmaken van een API-key vind je hier.

Resources:

Post measurement

URL:

POST /webservice/v2/measurements/messages/em

BODY:

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

PARAMETERS:

Naam Omschrijving
DELIVERYLevering integraal interval
DELIVERY_LOWLevering laag tarief interval
DELIVERY_HIGHLevering hoog tarief interval
BACKDELIVERYTeruglevering integraal interval
BACKDELIVERY_LOWTeruglevering laag tarief interval
BACKDELIVERY_HIGHTeruglevering hoog tarief interval
REACTIVE_DELIVERYLevering reactief (kVArh)
REACTIVE_DELIVERY_LOWLevering reactief laag tarief (kVArh)
REACTIVE_DELIVERY_HIGHLevering reactief hoog tarief (kVArh)
REACTIVE_BACKDELIVERYTeruglevering reactief integraal tarief (kVArh)
REACTIVE_BACKDELIVERY_LOWTeruglevering reactief laag tarief (kVArh)
REACTIVE_BACKDELIVERY_HIGHTeruglevering reactief hoog tarief (kVArh)

RESPONSE:

Log code (code:200 - OK)

Check log status

URL:

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

RESPONSE:

Log code (code: 200 - OK)

VOORBEELD:

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

 

Niet in staat om te vinden wat je zoekt?

Neem contact op met de Energiemissie servicedesk.