Informatie voor ontwikkelaars
Welkom! Dit is het startpunt voor jou als ontwikkelaar om je afnemende diensten te configureren binnen het toestemmingenplatform.
Voordat je hieraan begint adviseren wij om de algemene platform informatie te hebben bekeken en dien je in het bezit te zijn van een ontwikkelaar account. Op de volgende pagina’s kun je hier meer informatie over vinden:
Verder vind je hier informatie over hoe:
Wat heb je nodig?
Om aan de slag te kunnen gaan heb je een ontwikkelaar account nodig. Dit heb je gekregen van de beheerder van jouw organisatie. Je kunt hiermee afnemende diensten maken en wijzigen.
Je moet eerst je account activeren Indien je nog geen ontwikkelaar account hebt gekregen vind je hier informatie over hoe dit aangevraagd kan worden.
Voorwaarden
-
Je hebt de private (en public) RSA key bij de hand
Omschrijving proces toestemming geven en gegevens ophalen
Het vragen om toestemming omvat volgende stappen:
-
Een toestemming url is opgebouwd voor de consument
-
De consument autoriseert zich bij een Identity Provider (IDP) bijvoorbeeld iDIN of eHerkenning
-
De IDP redirect de browser van de consument naar de opgegeven callback url om de authorization code te retourneren aan de dienst.
-
Haal bij het token endpoint met de authorization code het access_token op.
-
Verifieer het access_token met de public keys die te vinden zijn op de jwks_uri. Die jwks_uri staat in het OpenID wellknown endpoint.
-
Haal uit het access_token het endpoint van de verstrekkende dienst.
-
Met dit access_token kan er data opgehaald worden bij de verstrekkende dienst.
Afnemende dient registeren
Een afnemende dienst is nodig om energie data op te halen voor de consument. Data van de consument kan vervolgens opgehaald worden op basis van een eenmalige of doorlopende toestemming. Als ontwikkelaar is het zaak om deze afnemende dienst dan ook te registreren in het toestemmingenplatform . Volg onderstaande gids om een afnemende dienst te registreren:
Vragen om Toestemming
Na registratie van de afnemende dienst kan aan consumenten toestemming worden gevraagd om hun energie gegevens uit de gekozen leverende dienst te delen. Hiervoor wordt OpenID Connect (OIDC) gebruikt. Om deze toestemming flow te starten moet de consument worden doorgestuurd naar het toestemmingenplatform met behulp van een opgebouwde URL.
Volg de stappen in deze gids om de URL op te bouwen welke een toestemming flow kan starten:
Data ophalen met toestemming
Nadat de consument toestemming heeft gegeven voor het delen zijn/haar kun je als dienst verlener met deze toestemming op zak hiervoor gegevens gaan ophalen uit naam van de consument m.b.v. het OAuth2 protocol.
-
Hoe je gegevens kan ophalen met een eenmalig toestemming.
-
Meerdere keren gegevens ophalen met een doorlopende toestemming.
Testen op acceptatieomgeving
→ Maak gebruik van onze Acceptatie omgeving om de technische koppeling te realiseren. Daarna is het mogelijk om toegang tot de productieomgeving aan te vragen. Op de acceptatieomgeving zijn deze test gebruikers beschikbaar.
Code voorbeelden
Er zijn hier verschillende java code voorbeelden te vinden.
OpenAPI Specificaties
OpenAPI specificatie voor de callback URL, te implementeren door de afnemende dienst: afnemer.yaml
OpenAPI specificatie voor de aan te roepen dataverstrekker (uit de endpoints.single_sync claim van de resource): generiek-verstrekken-single.yaml