Meetdata API (EM v2.0)

Inhoudsopgave

De inhoudsopgave wordt geladen...

Inleiding

De meetdata API maakt het mogelijk om meetdata op te vragen waartoe u toegang heeft. Deze API maakt gebruikt van Representational State Transfer (REST) om gegevens via het web te ontsluiten.

Heb je vragen of opmerkingen over de mogelijkheden tot data-ontsluiting of andere technische vragen, neem dan contact op met de servicedesk van Energiemissie 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

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.

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

GET: Meter list

URL:

GET /webservice/v2/meters

PARAMETERS:

Name	Description
status	string (query)
name	string (query)
ean	string (query)
street	string (query)
street_number	string (query)
street_number_addition	string (query)
postal_code	string (query)
city	string (query)

RESPONSE:

List of meters (code: 200 - OK)

VOORBEELD:

[
  {
    "id": "string",
    "uuid": "string",
    "status": "string",
    "meter_type_1": "string",
    "meter_type_2": "string",
    "meter_type_3": "string",
    "name": "string",
    "ean": "string",
    "street": "string",
    "street_number": "string",
    "street_number_addition": "string",
    "postal_code": "string",
    "city": "string",
    "gps": "string",
    "oda_status": "string|null",
    "measurement_data_source": "string",
    "contracted_capacity": "string",
    "measurement_data_source_timestamp": "int",
    "characteristics": [
      {
        "organisation_field_option": {
          "name": "string"
        },
        "value": "string",
        "created_at": "2001-01-01T00:00:00+01:00"
      }
    ],
    "created_at": "2001-01-01T00:00:00+01:00",
    "commodity": "string",
    "last_measurement_changes": "2001-01-01T00:00:00+01:00"
  }
]

GET: Month measurement

URL:

GET /webservice/v2/measurements/{meterId}/types/{type}/months/{year}/{month}

PARAMETERS:

Name	Description
meterId	string (UUID) (path)
type	string, options: `interval`, `daily`, `monthly` (path)
year	integer (yyyy) (path)
month	integer (1 - 12) (path)

RESPONSE:

Measurement response (code: 200 - OK)

VOORBEELD:

[
  {
    "channel": "string",
    "values": [
      {
        "timestamp": 123456789,
        "value": 1.1
      },
      {
        "timestamp": 123456789,
        "value": 1.1
      }
    ]
  }
]

GET: Day measurement

URL:

GET /webservice/v2/measurements/{meterId}/types/{type}/days/{year}/{month}/{day}

PARAMETERS:

Name	Description
meterId	string (UUID) (path)
type	string, options: `interval`, `daily` (path)
year	integer (yyyy) (path)
month	integer (1 - 12) (path)
day	integer (1 - 31) (path)

RESPONSE:

Measurement response (code: 200 - OK)

VOORBEELD:

[
  {
    "channel": "string",
    "values": [
      {
        "timestamp": 123456789,
        "value": 1.1
      },
      {
        "timestamp": 123456789,
        "value": 1.1
      }
    ]
  }
]

Channels

Channel	Type	Eenheid	Omschrijving
DELIVERY	Intervalwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Levering integraal
DELIVERY_LOW	Intervalwaarde	Elektra kWh	Levering laag
DELIVERY_HIGH	Intervalwaarde	Elektra kWh	Levering hoog
BACKDELIVERY	Intervalwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Teruglevering integraal
BACKDELIVERY_LOW	Intervalwaarde	Elektra kWh	Teruglevering laag
BACKDELIVERY_HIGH	Intervalwaarde	Elektra kWh	Teruglevering hoog
REACTIVE_DELIVERY	Intervalwaarde	Elektra kVARh	Levering blindstroom
REACTIVE_BACKDELIVERY	Intervalwaarde	Elektra kVARh	Teruglevering blindstroom
DELIVERY_MAX	Dagwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Max. gemeten klokkwartier of klokuur levering
BACKDELIVERY_MAX	Dagwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Max. gemeten klokkwartier of klokuur teruglevering
DELIVERY_MAX_INVOICE	Maandwaarde	Elektra kW Gas m3/h Warmte GJ/h Koude GJ/h	Max. gemeten piekwaarde levering factuurwaarden
BACKDELIVERY_MAX_INVOICE	Maandwaarde	Elektra kW Gas m3/h Warmte GJ/h Koude GJ/h	Max. gemeten piekwaarde teruglevering factuurwaarden
DELIVERY_INVOICE	Maandwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Levering integraal factuurwaarden
DELIVERY_LOW_INVOICE	Maandwaarde	Elektra kWh	Levering laag factuurwaarden
DELIVERY_HIGH_INVOICE	Maandwaarde	Elektra kWh	Levering hoog factuurwaarden
BACKDELIVERY_INVOICE	Maandwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Teruglevering integraal factuurwaarden
BACKDELIVERY_LOW_INVOICE	Maandwaarde	Elektra kWh	Teruglevering laag factuurwaarden
BACKDELIVERY_HIGH_INVOICE	Maandwaarde	Elektra kWh	Teruglevering hoog factuurwaarden
MANUAL_DELIVERY_LOW	Intervalwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Handmatig ingevoerde meetdata levering laag
MANUAL_DELIVERY_HIGH	Intervalwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Handmatig ingevoerde meetdata levering hoog
MANUAL_BACKDELIVERY_LOW	Intervalwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Handmatig ingevoerde meetdata teruglevering laag
MANUAL_BACKDELIVERY_HIGH	Intervalwaarde	Elektra kWh Gas m3 Warmte GJ Koude GJ	Handmatig ingevoerde meetdata teruglevering hoog

Niet in staat om te vinden wat je zoekt?

Neem contact op met de Energiemissie servicedesk.

✉️ : support@energiemissie.nl
☎️ : +31 85 016 0126