zal de informatie op https://prod.dosis-burgers.vlaanderen.be/ vervangen
Referentie magda documentendienst/REST diensten documentatie: https://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/1602748845/Token-gebaseerde+diensten#Fase-0%3A-Opzet-bij-de-Token-provider-van-de-Vlaamse-Overheid-(AIV-AAS)
Fasen/topics/stappen te doorlopen
Security (Geosecure OAuth 2.0) (zowel D+N)
algemene uitleg over hoe de api beveiligd is: OAuth 2.0 / client credentials
(https://beta.oauth.vlaanderen.be/authorization/Help/Api/ClientCredentialsGrant)korte uitleg over gebruik van JWK: assymetrische sleutels (ipv client id/client secret)
codevoorbeelden
.NET om JWT (op basis van JWK)JSON Web Token
fase 1 van magda docs: https://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/1602748845/Token-gebaseerde+diensten#Fase-0%3A-Opzet-bij-de-Token-provider-van-de-Vlaamse-Overheid-(AIV-AAS)
Hoe een keypair genereren:
https://beta.oauth.vlaanderen.be/authorization/Help/Api/GenerateJsonWebKey
nog op zoek gaan naar alternatieve tools: via openssl commando / online tooltje / link naar de RFC https://tools.ietf.org/html/rfc7517
hoe je geosecure oauth client instellen: concreet: hoe je keypair (jwk) gaan opladen in de geosecure interface. => word doc severien (Geosecure_MAGDA.docx mail van 23/03)
Pas hierna kan de oauth client gebruikt worden om calls naar de DOSIS api te doen.
Moet dus ook terug een link bevatten naar “hoe een keypair genereren”
Info |
---|
tot hierboven is het dus algemene uitleg over welke oauth flow we gebruiken + hoe je de toegewezen geosecure client “inregelt” zodat hij klaar is voor gebruik |
...
technische uitleg/voorbeelden voor bekomen van een access token adhv client credentials grant.
(preconditie: client op geosecure is ingeregeld: json web key is opgeladen)
referentiemateriaal:https://beta.oauth.vlaanderen.be/authorization/Help/Api/ClientCredentialsGrant : schema (overview flow) + obtaining access tokens
+ aanvullen met geosecure info op https://beta.oauth.vlaanderen.be/authorization/Help/Api/ClientAuthentication#private_key_jwt
=> vanaf Incorporation of the JSON Web Token in the body of the requesthttps://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/1602748845/Token-gebaseerde+diensten#Aanvraag-HTTP-request => stukje vanaf “aanvraag http request”
Het antwoord dat je van geosecure terugkrijgt = dit is het access token dat je uiteindelijk nodig hebt om effectief een DOSIS api call te kunnen doen:
Info |
---|
nu heeft de integrator een access token waar hij de DOSIS (en notificatie) api mee kan aanroepen |
DOSIS configuratie
Doel:
de gewenste IPDC producten moeten geconfigureerd staan in DOSIS:
kan reeds op voorhand klaar staan door opzet aansluitingenteam (bvb pakketconfiguratie of aparte IPDC producten)
kan ook door de afnemer zelf (deels) geconfigureerd worden:
extra ipdc producten toevoegen
vlaamse/fasen coden
Producten configureren (in portaal)
Technisch contactpersoon wordt de rol toegewezen om in het DOSIS portaal voor de toegewezen bron uri de configuratie van de IPDC producten op te zetten.
BETA: https://beta.dosis.dev-vlaanderen.be/
TNI: http://tni.dosis.dev-vlaanderen.be/
PROD: https://prod.dosis-burgers.vlaanderen.be/Todo’s:
check de lijst met producten
check of de config per product ok is:
welke vlaamse fasen zullen er gebruikt worden
volgorde van de vlaamse fasen
passieve notifificatie: standaard aangevinkt => uitleggen dat als dit aangevinkt is er in MBP automatisch een passieve notificatie wordt verstuurd in geval er een dossierstatusupdate wordt doorgestuurd
Opmerking: het eloket voor ondernemers ondersteunt nog GEEN notificaties.
Het aangevinkt laten kan echter geen kwaad => er gebeurt gewoon niets mee.
+ belang van juiste config duiden: impact op aantal/volgorde van de bollen in het eloket.
...
Enkel voorpakketconfiguratie:
doorgaans enkel van toepassing voor dienstenleveranciers:
Voor wijzigingen aan het pakket moet je contact opnemen met onze service desk (link naar een nog te maken Jira service desk formulier).Het is wel mogelijk om ZELF per bron wijzigingen door te voeren: bvb producten te wijzigen of toe te voegen.
Dit moet je dan wel voor alle bronnen doen.
DOSIS API aanroepen
Basisprincipes uitleggen
wat is de dosis bron uri (die je ontving bij onboarding)
wordt toegewezen bij aansluiting
vormt samen met het eigen dossiernummer de unieke identificatie voor een dossier binnen DOSIS
bij elke dossier status wijziging wordt dus de bron uri + dossiernummer doorgestuurd. https://beta.dosis.dev-vlaanderen.be/api/help/model?modelnaam=DossierIdentificatie
"Identificatie": {
"Bron": "urn://digitaalvlaanderen.be/applicatie", => namespace vast toegewezen door AIV
"DossierNummer": "eigen dossiernummer EV" => “eigen referentie”, nummer, … whatever
},Nota: indien de aansluitende partij met meerdere backend systemen werkt en er daartussen overlap is in de dossiernummers, is het aangewezen om meerdere bron uri’s aan te vragen.
bvb: systeem voor burgers vs systeem voor ondernemers: beide een dossiernummer “1000” => zorgt voor problemen als je maar 1 enkele bron uri hebt.
voorbeeld: beter dan om urn://zaventem.be/burgers en urn://zaventem.be/ondernemers” aan te vragen.
OAuth client
begrippenlijst in 't algemeen: …
minimale API calls voor standaard DOSIS integratie: https://vlaamseoverheid.atlassian.net/wiki/spaces/WPMBP/pages/2536964391/Aanzet+stappenplan+instructies+Aansluiten+op+dossierstatusinformatie+en+notificaties#API-calls
Info |
---|
uitklaren met DGN team voor gebruik URI vs URN https://nl.wikipedia.org/wiki/Uniform_resource_identifier#:~:text=De%20uniform%20resource%20locator%20(URL,als%20URL%20%C3%A9n%20als%20URN. |
Hoe testen en valideren tijdens de ontwikkeling
TESTEN
Uitleg over hoe de systemen gekoppeld zijn:
DOSIS BETA is gelinkt met MBP frontend BETA => zit achter een mock OpenID Connect (OIDC) implementatie:
hier kan je makkelijk met een zelf ingegeven RRN inloggen.DOSIS TNI is gelinkt met MBP TNI => zit achter ACM-IDM. Enkel aanmelden met sterke authenticatie.
Gebruiker moet bekend zijn bij ACM-IDM T&I
ADVIES: integratie met de BETA omgeving: gebruik GEEN persoonsgevoelige of echte data.
reden: iedereen kan met gelijk welk RRN inloggen op MBP front.
Dit is ook net het voordeel om snel te kunnen testen.=> laagdrempelig om te testen.
OPM: indien je test met persoonsgevoelige (of “echte”) data dan aanbevolen om met TNI te integreren.
Voor burgers: iedere burger kan inloggen via ACM T&I via sterke authenticatie
Voor ondernemers: ook in IDM T&I moet je een account hebben => kan door de IDM toegangsbeheerder toegekend
Als je via de TNI omgeving wil integreren: contact opnemen met aansluitingenteam (=>dan moeten wij ook nog een TNI bron uri gaan opzetten)
URL MBP front: https://beta.frontend.burgerprofiel.dev-vlaanderen.be/ (BETA)
https://tni.frontend.burgerprofiel.dev-vlaanderen.be/ (TNI)
HOE NAAR PRODUCTIE GAAN
Alvorens naar productie te gaan vragen we een basis set testen op de beta (of TNI) omgeving.
Note |
---|
open discussiepunt: (wat) willen we vanuit AIV valideren - nog af te stemmen. |
Daarna: aanvraag richten aan aansluitingenteam: best reply op de mail die je ontvangen hebt.
Vermeld telkens de bron URI om aan te geven over welke aansluiting het gaat.
Na ontvangst productiegegevens (bron uri + oauth client) => seintje geven van zodra de go-live gebeurd is zodat wij het dossier kunnen afronden.
je ontvangt dan verdere info mbt nazorg (service delivery)
Voorbeeld/referentie implementaties
Nodig:
visuele mapping van velden uit de payload naar schermen van zowel e-loket als MBP : wat komt nu waar te staan?
Voorbeeldjes uitwerken:
heel eenvoudig voorbeeld: minimale zaken die naar dosis moet doorsturen (GEEN url, GEEN dossierbeheerder) => heel kort voorbeeldje
“technisch” voorbeeld: sluit aan op visuele mapping: bvb als payload “dit is het dosssiernummer”, “dit is de omschrijving van je dossier ExtraInformatie.
+ screenshot dan van eloket en MBP front van hoe het getoond wordt (ipv screenshots kan dit ook inloggen zijn met een vast demoprofiel)Voorbeelden voor VO-entiteit: vaak 1 specifiek IPDC product:
Vb: omgevingsvergunning aanvragen, aanvraag van een subsidie.Voorbeelden voor lokale besturen: inschrijving als burger bij de gemeente, aanvraag toegang tot recyclagepark,
DEMO omgeving: propere omgeving zonder veel andere brol:
eentje voor VO-demo’s
eentje voor LB-demo’s
eentje voor technische demo’s
(concreet aantal test RRN’s en KBO nummers)