API | VEKA |
|---|
energieAttesten | |
Doel | Gegevens over een |
|---|
(historisch) ingediend energieprestatiecertificaat opzoeken en uitlezen | |
Locatie | Testomgeving: |
|---|
https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten |
Toegang
Voor softwareleveranciers (aanvraag: Toegang voor softwareleveranciers)
| Inhoudsopgave |
|---|
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
...
...
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
...
...
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
| View file | ||
|---|---|---|
|
Formaat van request
| Codeblok | ||
|---|---|---|
| ||
{
"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 (vb. 201)
Response: Bevestiging en uniek VEKA meldingsnummer
| Codeblok | ||
|---|---|---|
| ||
{
"externeReferte": "0-1234-ABCD",
"meldingsnummer": "2023-CV-K-1",
"message": "Melding 2023-CV-K-1 correct opgeladen."
} |
Foutieve melding
HTTP Code: 4xx (vb. 400, 404)
Response: Lijst van fouten gevonden in de melding
...
| language | json |
|---|
...
https://energie-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten | |||||
Toegang | Voor overheden, lokale besturen, … op basis van een vooraf afgesloten protocol en ontsloten via een PKI-certificaat Aansluitingsaanvragen kunnen gericht worden naar privacy.veka@vlaanderen.be Eventueel met een reeds ingevuld protocol
| ||||
|---|---|---|---|---|---|
Technische informatie | https://github.com/OVO000090/VEKA_REST_API/blob/main/docs/energie-attesten-uat-v1.md https://github.com/OVO000090/VEKA_REST_API/blob/main/docs/energie-attesten-prod-v1.md |
| Inhoudsopgave |
|---|
Implementatie
Deze API is ontwikkeld voor externe partijen die informatie betreffende ingediende energieattesten nodig hebben in kader van het realiseren van een welomschreven doeleinde, dat vooraf werd vastgelegd in een protocol en een verwerkersovereenkomst met het Vlaams Energie- en Klimaatagentschap (VEKA).
Het is een private API waarbij externe partijen specifiek de toestemming nodig hebben om toegang te verkrijgen.
In het kader van onderlinge afspraken tussen de afnemer en VEKA rond data-uitwisseling, gespecifieerd in het protocol, is het mogelijk dat een afnemer niet alle informatie beschreven in dit document kan consulteren. Het VEKA kan immers per afnemer verdere filtering toepassen.
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
...
...
Test API
...
Publieke versie
...
Authenticatie
...
Geen
...
Locatie
...