Ontsluiten van verbruiksdata via API

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

Hoe ontsluiten van verbruiksdata via API aanvragen?

Stap 1: Meld je aan op Mijn Fluvius

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

Meer informatie over inloggen als een organisatie in Mijn Fluvius.

Meld je aan op Mijn Fluvius als organisatie

Stap 2: Maak je kenbaar als energie dienstverlener

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

Maak je kenbaar als energie dienstverlener

Stap 3: Sluit een datatoegangscontract af

Vooraleer je als Energie dienstverlener 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)’.

Datatoegangscontract aanvragen voor API

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.

Waar vind ik mijn datatoegangscontract terug?

Stap 4: Maak de ‘handshake’ met de Fluvius-systemen in het onboarding proces

Vooraleer je de API kan gebruiken moet je je systemen integreren met die van Fluvius. De stappen die hiervoor moet doorlopen vind je terug in het document "Ontsluiten van verbruiksdata via API".

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

  • De POST shortURL: om klanten door te verwijzen naar Mijn Fluvius zodat ze jou toestemming kunnen geven
  • De GET mandate: om de status van je mandaten te raadplegen
  • De GET energy: om verbruiksgegevens op te halen

We lichten de drie API’s 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 reply berichten die je zal ontvangen. Meer informatie over het gebruik van de sandbox vind je terug in het document ‘Datavisualisatie en datarapport via Mijn Fluvius'.

Stap 5: Verwijs je klanten door naar Mijn Fluvius om verbruiken te delen met jou

Eindklanten starten steeds op de website van de Energie dienstverlener met de vraag om producten of diensten op basis van zijn energieverbruik te ontvangen. Verwijs hen eerst door naar Mijn Fluvius, waar ze een aanvraag kunnen indienen om verbruiken te delen. Daarna kan je de status van de aanvragen en de verbruiken zelf opvragen via de API. Je vindt een overzicht in deze infographic.

Energiedienst verlener met API

Als eerste stap gebruik je de POST shortURL om de klant door te verwijzen. Via deze API 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 API kies je het referentienummer waaronder je je klant zal doorverwijzen. Dit is de communicatiesleutel tussen de klant, de dienstverlener en Fluvius. Onder dit referentienummer zullen de verbruiken aangevraagd worden.

Je kan de aanvraag van je klant ook sturen, bijvoorbeeld door zelf het detailniveau van de verbruiken te bepalen die de klant zal aanvragen: dagverbruiken en/of kwartierverbruiken (elektriciteit) of uurverbruiken (gas). Je kan ook de start- en einddatum van de verbruiken 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 verbruiken 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 Energie dienstverlener zijn meegegeven in de API.

Stap 6: Vraag de status van je klant mandaat op via de API

Je kan de status van de aangevraagde verbruiken (= mandaten) raadplegen via de ‘GET mandate’ API. Als deze API aangeeft dat een aanvraag op ‘goedgekeurd’ staat, kan je deze verbruiken opvragen via de ‘GET energy’ API.

Stap 7: Vraag de verbruiken op via de API

Via de ‘GET energy API’ kan je verbruiken opvragen. Je kiest daarvoor het referentienummer, de EAN-code, het detailniveau en de verbruiksperiode waarvoor je verbruiken wil opvragen.

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

PDF Document | 2.53 MB