Ontsluiten van verbruiksdata via API

De dienst ‘ontsluiten van verbruiksdata via API’ maakt het voor een energiedienstverlener mogelijk om dagelijks automatisch meetgegevens van zijn klant met een digitale meter of AMR-meter op te vragen.

Om te starten meld je je eerst aan op Mijn Fluvius met je professioneel account. Dit doe je met je eID of Itsme. Enkel personen gemachtigd om op te treden namens jouw organisatie kunnen aanmelden.

Meer informatie over inloggen met je professioneel account in Mijn Fluvius.

Dit doe je door op de landingspagina via het potlood-icoontje aan te geven dat je je hoedanigheid van ‘Organisatie’ wil wijzigen naar ‘Energiedienstverlener’.

Vooraleer je als energiedienstverlener toegang krijgt tot informatieve meetgegevens moet je eerst een datatoegangscontract afsluiten met Fluvius.

Voor het aanvragen van een datatoegangscontract en deze dienst kunnen kosten worden aangerekend. Voor meer informatie kan je terecht bij vreg.be.

Wanneer in het aanvraagproces wordt gevraagd om een kanaal te kiezen, klik dan op API (+ deze website)’.

Nadat je datatoegangscontract is aangevraagd, zal je een e-mail ontvangen met daarin een blanco exemplaar. Dit exemplaar stuur je gehandtekend terug. Je kan je contract ook terugvinden en beheren in Mijn Profiel.

Vooraleer je de API kan gebruiken moet je je systemen integreren met die van Fluvius. De stappen die je hiervoor moet doorlopen vind je terug in de documenten onderaan deze pagina.

Tijdens het onboarding proces zal je toegang krijgen tot de drie API endpoints die je nodig hebt om meetgegevens van klanten op te vragen:

• POST shortURL: Je maakt een URL aan waarmee je de klant doorverwijst naar Mijn Fluvius om daar een aanvraag voor het delen van meetgegevens in te dienen.
• GET mandate: Je volgt de toegangen tot de meetgegevens op.
• GET energy: Je vraagt de nodige meetgegevens op.

We lichten de drie API endpoints verder toe in deze tekst.

Daarbovenop biedt Fluvius ook een testomgeving aan. Daarin kan je je systemen alvast afstellen op de API-parameters die je als input moet meegeven, alsook de inhoud van de antwoorden die je zal ontvangen. Meer informatie over het gebruik van de sandbox vind je terug in de documenten onderaan deze pagina.

Eindklanten starten steeds op de website van de energiedienstverlener met de vraag om producten of diensten op basis van zijn energiegegevens te ontvangen. Verwijs hen eerst door naar Mijn Fluvius, waar ze een aanvraag kunnen indienen om toegang tot meetgegevens te verlenen. Daarna kan je de status van de toegangen en de meetgegevens zelf opvragen via de API. Je vindt een overzicht in deze infographic.

Als eerste stap gebruik je de POST shortURL om de klant door te verwijzen. Via dit endpoint krijg je van Fluvius een URL waarmee je je klant kan doorverwijzen naar mijn.fluvius.be. De URL is 24 uur geldig. Bij het gebruik van de POST shortURL endpoint kies je het referentienummer waaronder je je klant zal doorverwijzen. Dit is de communicatiesleutel tussen de klant, de dienstverlener en Fluvius. Onder dit referentienummer zal de toegang tot de meetgegevens aangevraagd worden.

Je kan de aanvraag van je klant ook sturen, bijvoorbeeld door zelf het detailniveau van de meetgegevens waartoe de klant toegang zal verlenen, te bepalen: daggegevens en/of kwartiergegevens (elektriciteit) of uurgegevens (gas). Je kan ook de start- en einddatum van de gegevens bepalen en je moet aangeven of je klant inlogt als particulier of als organisatie. Als laatste kan je bepalen wat het maximale aantal EAN-codes is waarvoor de klant gegevens met jou kan delen.

Afhankelijk van deze parameters zal de klant een of meerdere keuzes moeten maken bij zijn aanvraag. De keuze van de EAN-code ligt steeds bij de klant.

Na de aanvraag kan je klant ervoor kiezen om terug doorverwezen te worden naar jouw website. Fluvius gebruikt dan de URL’s die door jou als energiedienstverlener zijn meegegeven bij het aanmaken van de shortURL.

Je kan je toegang tot meetgegevens raadplegen via het GET Mandate endpoint. Als de respons van de API aangeeft dat een bepaalde toegang is goedgekeurd (‘Approved’), dan kun je deze meetgegevens opvragen via het GET Energy endpoint.

Via de GET energy endpoint kan je meetgegevens opvragen. Je kiest daarvoor het referentienummer, de EAN-code, het detailniveau en de verbruiksperiode waarvoor je de gegevens wil opvragen.

Hier vind je de nodige documentatie om aan de slag te gaan: