API	VEKA Meldingen API (OpenAPI specificaties)
Doel	Gegevens over een uitgevoerde keuring of onderhoud van centrale stooktoestellen aanleveren
Locatie	Testomgeving: https://vlaamsenergieagentschap.atlassian.net/wiki/spaces/TDV/pages/2294841459/Meldingen+API#Testomgeving Productie: Nog niet beschikbaar
Toegang	Voor softwareleveranciers (aanvraag: Toegang voor softwareleveranciers)

Implementatie

API call	POST /meldingen-api-a2a/extern/v1/meldingCentraleStooktoestellen
Beschrijving	API call voor het melden van een keuring of onderhoud van een centraal stooktoestel

De belangrijkste voorwaarden om de gegevens voor een melding te aanvaarden zijn:

De HVAC onderneming melder is geregistreerd en actief op het moment van opladen
De activiteit keuring of onderhoud werd nog niet gemeld aan het VEKA (op basis van eigen externe refertenummer)
De datum van de activiteit keuring of onderhoud ligt niet in de toekomst
De technicus is gekend bij de Vlaamse Overheid en mag de keuring en onderhoud van centrale stooktoestellen uitvoeren op datum van de activiteit
Het correcte identificatienummer voor adres, gebouw en gebouweenheid werd meegeleverd zoals opgenomen in het adres- en gebouwregister van de Vlaamse Overheid
- Bij voorkeur door doorgave van het gebouw(eenheid)ID.
- In eerste fase is minstens het adresID verplicht

Overzicht van de invoervelden

Veldnaam	Omschrijving	Toegelaten waarden
externeReferte	Unieke ID uit eigen software
ondernemingsnummer	KBO nummer of ondernemingsnummer van de HVAC onderneming melder
activiteitType	Uitgevoerde ativiteit die wordt gemeld	Keuze: Keuring voor eerste ingebruikname Onderhoud
datumActiviteit	Datum waarop de activiteit keuring of onderhoud werd uitgevoerd door de erkende technicus
erkenningsnummer	Erkenningsnummer van de technicus die de activiteit keuring of onderhoud heeft uitgevoerd
verwarmingType		Keuze: individueel collectief onbekend
adresId	AdresID uit het adresregister van de Vlaamse overheid	https://vo-veka.atlassian.net/wiki/spaces/TDV/pages/2321580033/Locatie+van+een+stooktoestel#API-endpoints
gebouwId	GebouwID uit het gebouwregister van de Vlaamse overheid
gebouwIdNietGekend	True indien de gebruiker via de toepassing heeft aangegeven na nazicht op de kaart dat het gebouwID onbekend is in het basisregister	Keuze True False
gebouweenheidId	GebouwEenheidID uit het gebouwregister van de Vlaamse overheid	https://vo-veka.atlassian.net/wiki/spaces/TDV/pages/2321580033/Locatie+van+een+stooktoestel#API-endpoints
gebouweenheidIdNietGekend	True indien de gebruiker via de toepassing heeft aangegeven na nazicht op de kaart dat het gebouweenheidID onbekend is in het basisregister	Keuze: True False
fabricatienummer	Fabricatienummer van het stooktoestel
fabricatienummerNietGekend	True indien de technicus het Fabricatienummer niet heeft aangeleverd	Keuze: True False
nominaalVermogen	Nominaal vermogen van het stooktoestel (in kW)	double
brandstof		Keuze: Aardgas Stookolie Houtpellets LPG Houtblokken Gas – type onbekend Vloeibaar – type onbekend Vast – type onbekend
branderTechnologie		Keuze: •Premix (GI) •Niet premix (GI) •Gasketel met ventillatorbrander (GI)
merk	Merk van het stooktoestel
merkNietGekend	True indien de technicus het merk van het stooktoestel niet heeft aangeleverd	Keuze: True False
type	Type of model van het stooktoestel
typeNietGekend		Keuze: True False
werking		Keuze Condenserend Niet – condenserend Onbekend
bouwjaar	Bouwjaar van het stooktoestel	numeriek
bouwjaarNietGekend	True indien de technicus het bouwjaar van het stooktoestel niet heeft aangeleverd	Keuze: True False
stooktoestelConform		Keuze: OK Niet OK
rookgasafvoerkanaalConform		Keuze: OK Niet OK
stookplaatsConform		Keuze: OK Niet OK
verbrandingscontrole		Keuze: OK Niet OK
toestelWerkingGoed		Keuze: Goed Niet goed
toestelWerkingVeilig		Keuze: Veilig Niet veilig

Zie ook bijlage: MeldingCentraleStooktoestellen - velden API.xlsx

Formaat van request

{
  "externeReferte": "0-1234-ABCD",
  "ondernemingsnummer": "1234567890",
  "gegevensActiviteit": {
    "activiteitType": "Keuring voor eerste ingebruikname",
    "datumActiviteit": "2023-02-14",
    "erkenningsnummer": "TV12345",
    "verwarmingType": "Individueel",
    "adresId": "12345",
    "gebouwId": "9400001",
    "gebouwIdNietGekend": false,
    "gebouweenheidId": "9400075"
    "gebouweenheidIdNietGekend": false
  },
  "kenmerkenToestel": {
    "bouwjaar": 2023,
    "bouwjaarNietGekend": false,
    "fabricatienummer": "A12345678",
    "fabricatienummerNietGekend": false,
    "nominaalVermogen": 21,
    "brandstof": "Aardgas",
    "branderTechnologie": "Premix (GI)",
    "merk": "Merknaam",
    "merkNietGekend": false,
    "type": "type toestel",
    "typeNietGekend": false, 
    "werking": "Condenserende ketel"
  },
  "eindbeoordeling": {
    "stooktoestelConform": "OK",
    "rookgasafvoerkanaalConform": "NOK",
    "stookplaatsConform": "OK",
    "verbrandingscontrole": "NOK",
    "toestelWerkingGoed": "Goed",
    "toestelWerkingVeilig": "Veilig"
  }
}

Formaat van response

Succesvolle melding

HTTP Code: 2xx (e.g. 201)
Response: Bevestiging en uniek VEKA meldingsnummer

{
  "externeReferte": "0-1234-ABCD",
  "meldingsnummer": "2023-CV-K-1",
  "message": "Melding 2023-CV-K-1 correct opgeladen."
}

Foutieve melding

HTTP Code: 4xx (e.g. 400, 404)
Response: Lijst van fouten gevonden in de melding

{
  "timestamp": "2023-02-14T15:24:08.664+01:00",
  "status": 4xx,
  "error": "Bad Request",
  "externeReferte": "0-1234-ABCD",
  "errors": [
    {
      "message": "De meegegeven waarde is niet toegestaan: Goedkeuring. Mogelijke waarden zijn: Keuring voor eerste ingebruikname, Onderhoud",
      "field": "activiteitType",
      "rejectedValue": "Goedkeuring"
    },
    {
      "message": "Datum van de melding mag niet in de toekomst."
    },
    {
      "message": "Het erkenningsnummer wordt niet herkend."
    }
}

Security van de webservices

De web services (REST APIs) voor het melden van centrale stooktoestellen zijn niet publiek beschikbaar. De API vereist gebruik van certificaten voor het tot stand brengen van mutual TLS. Zo kan zowel de client als de server de identiteit van de andere partij valideren.

Meer informatie rond het opzetten van mutual TLS is vrij te vinden op het internet.

Testomgeving

VEKA voorziet een test-versie van de API om de implementatie door de softwareleverancier te faciliteren. Er zijn twee versies beschikbaar: één beveiligde API en één publiek toegankelijke. Beide APIs bevatten dezelfde logica.

Toegang tot de Meldingen API kan aangevraagd worden via: Toegang voor softwareleveranciers

Test API	Beveiligde versie
Authenticatie	Test certificaat CN={ondernemingsnummer}-test.softwareleverancier.veka.vlaanderen.be
Locatie	https://energie-ti-secure.api.vlaanderen.be/meldingen-api-a2a/v1/extern/meldingCentraleStooktoestellen

Test API	Publieke versie
Authenticatie	Geen
Locatie	https://energie-ti.api.vlaanderen.be/meldingen-api-a2a/v1/extern/meldingCentraleStooktoestellen