www.vlaanderen.be/radicaaldigitaal

Aansluitingsprocessen op de DOSIS API

Aansluiten op DOSIS

Overzicht

Aansluiten op DOSIS 2

> Aansluiten als bron

> Aansluiten als afnemer

> Nuttige informatie bij het aansluiten op DOSIS en MAGDA

> Gebruik van de notificatie API voor het notificeren van statuswijzigingen in dossiers opgeladen in DOSIS

> Wat is een bron voor de DOSIS API?

> Welke stappen moet een bron doorlopen om aan te sluiten op DOSIS?

Aansluiten als bron

Aansluiten op DOSIS 3

> Wat is een bron voor de DOSIS API?

“Elke Vlaamse overheidsdienst die dienstverlening aanbiedt aan een onderneming gevestigd in Vlaanderen of aan een burger woonachtig in Vlaanderen.”

> Een bron kan rechtstreeks aansluiten op de DOSIS API of via een SOAP interface met MAGDA afhankelijk van het niveau van informatiegevoeligheid van de dossiers:

o Dossiers voor burgerzaken -> steeds via MAGDA

o Dossiers voor ondernemingszaken -> rechtstreeks op DOSIS API of via MAGDA

Aansluiten als bron

Aansluiten op DOSIS 4

> Welke algemene stappen moet een bron doorlopen om aan te sluiten op DOSIS?

1. Intake gesprek met bron (kandidaat partner)

2. Bespreken scope van de integratie (producten, bronapplicaties, integratiescenario’s) en mogelijke planning

3. Invullen en opleveren formeel intakedossier DOSIS push

4. Aansluiting op Geosecure

5. Configuratie bron, producten en fases in DOSIS

6. Ontwikkeling uploadmethode naar DOSIS API + validatiemethode uploads

7. Testing op DOSIS beta

8. Promotie naar DOSIS staging voor acceptatietesten

9. Nota aan VTC voor toevoeging nieuwe bron aan machtinging DOSIS en e-loket

10. In productiestelling volgens draaiboek DOSIS en partners

Aansluiten als bron: dossierpush naar DOSIS

Aansluiten op DOSIS 5

1 2 3 4 5 6 7 8 9 10

> Welke algemene stappen moet een bron doorlopen om aan te sluiten op DOSIS via MAGDA?

Aansluiten als bron op DOSIS via MAGDA: push en pull

Aansluiten op DOSIS 6

1 2 3 4 5

1. Intake gesprek met bron

2. Bespreken scope van de integratie (producten, bronapplicaties, integratiescenario’s) en

mogelijke planning

3. Invullen en opleveren formeel intakedossier DOSIS push

4. Configuratie bron, maatregelen en fases in DOSIS

5. Formele start implementatie push of pull scenario ism MAGDA TEAM

6.a. Indienen MAGDA toelatingsaanvraag voor de aansluiting als afnemer op DOSIS-diensten via MAGDA

7.a. Configuratie URI's/CN’s (Common Names) als contextwaarde in de toepassing Gebruikersbeheer

8.a. Aanvraag certificaten voor connectie naar MAGDA in Digitaal Certificatenbeheer Platform + installatie certificaten

9.a. Bouw dossierpush naar 6 SOAP-endpoints vanuit brontoepassing + validatie uploadstatus

10.a Connectie op SOAP-endpoints op MAGDA T&I (en DOSIS beta) + testing data upload

11.a Toevoeging bron aan bestaande machtiging DOSIS, MAGDA en Loket via nota aan VTC

12.a In productiestelling volgens gezamenlijke draaiboek DOSIS, MAGDA en partners

Aansluiten als bron op DOSIS via MAGDA: PUSH scenario

Aansluiten op DOSIS 7

1 2 3 4 5

6a

6b

7a

7b

8a

8b

9a

9b

10

a

10

b

11

a12

a

11

b12

b

6.b. Indienen MAGDA toelatingsaanvraag voor de registratie als bron voor MAGDA

7.b. Configuratie URI's/CN’s (Common Names) als contextwaarde in de toepassing Gebruikersbeheer

8.b. Aanvraag certificaten voor connectie naar MAGDA in Digitaal Certificatenbeheer Platform + installatie certificaten

9.b. Bouw van toepassing voor het ‘pullen’ van dossierstatusinfo inclusief historiek via MAGDA SOAP-endpoint

10.b. Connectie op SOAP-endpoint op MAGDA T&I (en DOSIS beta) + beschikbaar stellen testdata in toepassing

die wordt gekoppeld aan MAGDA als bron voor dossierstatusinformatie

11.b Toevoeging bron aan bestaande machtiging DOSIS, MAGDA en Loket via nota aan VTC

12.b In productiestelling volgens gezamenlijke draaiboek DOSIS, MAGDA en partners

Aansluiten als bron op DOSIS via MAGDA: PULL scenario

Aansluiten op DOSIS 8

1 2 3 4 5

6a

6b

7a

7b

8a

8b

9a

9b

10b

10

a

11

a12

a

11

a12

a

MOMENTEEL IN BOUWFASE – ONDERHEVIG AAN WIJZIGINGEN

> Wat is een afnemer voor de DOSIS API?

> Welke stappen moet een afnemer doorlopen om aan te sluiten op DOSIS?

Aansluiten als afnemer

Aansluiten op DOSIS 9

> Wat is een afnemer voor de DOSIS API?

Een afnemer is een toepassing die dossierstatusinformatie wil ontsluiten naar een voor haar relevant doelpubliek(*). Dit doelpubliek moet noodzakelijkerwijs rechten hebben om de dossierstatussen opgeladen in DOSIS te kunnen raadplegen. Het ontsluiten kan via een webtoepassing, een mobiele toepassing of een klassieke geprogrammeerde toepassing.

(*) ondernemingen en/of burgers

Aansluiten als afnemer

Aansluiten op DOSIS 10

Aansluiten op DOSIS als afnemer

Aansluiten op DOSIS 11

> Welke algemene stappen moet een afnemer doorlopen om aan te sluiten op DOSIS?

1. Intake gesprek afnemer, DOSIS-team en team OpenIDConnect HFB

2. Opstart integratiedossier OpenIDConnect ism HFB

3. Technische integratie op OpenIDConnect met client id ontvangen in na stap 2

4. OPTIONEEL: Aansluiting op Geosecure om zelf testdossierstatussen te kunnen opladen

5. OPTIONEEL: Configuratie testbron, test maatregelen en fases in DOSIS

6. Integratie op DOSIS API voor het opvragen van dossierstatussen d.m.v. de beschikbare API-methodes

7. Koppeling test-omgeving van de eigen toepassing op DOSIS beta + uitvoeren testen

8. Promotie naar DOSIS staging voor acceptatietesten

9. Beslissing in productiestelling + formaliteiten t.a.v. VTC (*)

10. In productiestelling

1 2 3 4 5 6 7 8 9 10

(*) gesprekken met VTC kunnen best al opgestart worden na stap 1

▪ Documentatiesite van de DOSIS API: beta.dosis.vlaanderen.be• met documentatie over API en methodes

• met checklist voor integratie op DOSIS API

• met template voor statusmapping op DOSIS status attributen

▪ MAGDA documentatie:• XSD’s bij SOAP-endpoints DOSIS push en pull

• Handleidingen bij SOAP-endpoints DOSIS push en pull

• Begeleiding en documentatie aanvraag certificaten en aansluiting op MAGDA

Nuttige informatie bij het aansluiten op DOSIS en MAGDA

Aansluiten op DOSIS 12

▪ Een bron (kandidaat-partner) wordt bij aansluiting op DOSIS gevraagd naar interesse om ook de Notificatie API te gebruiken volgens welk scenario:

• Contactgegevens en consent worden overgedragen van bron aan de notificatie- en contactvoorkeuren API

• Contactgegevens en consent blijven bij de bron, welke ze ter beschikking stelt van de notificatie API bij het verzenden van notificaties

▪ Bij concrete interesse wordt een intake gesprek gedaan waarna een formele onboarding volgt

▪ Onboarding document vat alle nodige informatie samen om de nodige configuratie te kunnen uitvoeren in:

• DOSIS

• De Notificatie API

• De Contactvoorkeuren API

Gebruik van de notificatie API in combinatie met DOSIS

Aansluiten op DOSIS

1. Intake gesprek

2. Onboarding document

3. Configuratie in DOSIS

4. Configuratie in Notificatie API

5. Configuratie in Contactvoorkeur API

6. Configuratie door bron (kandidaat partner) in de DOSIS Instellingen

Gebruik van de notificatie API in combinatie met DOSIS: aansluitingsproces

Aansluiten op DOSIS

1 2 3 4 65

7a

7b

8a

8b

9a

9b

10

a

10

b

11

a12

a

7.a. Bron kiest voor scenario waarin consent en contactgegevens worden overgedragen aan de (Notificatie-) & Contactvoorkeuren API

8.a. Notificatie API-team levert specs aan voor initiële upload

9.a. Bron maakt initiële upload aan volgens specs

10.a. Initiële upload in Contactvoorkeuren API

11.a. Beheer en ontsluiting voortaan via Contactvoorkeuren API

12.a. Notificatie API gebruikt contactgegevens en consent – bron beheert en gebruikt de contactgegevens en consent niet meer na initiële upload

Gebruik van de notificatie API in combinatie met DOSIS: aansluitingsproces (scenario 1)

Aansluiten op DOSIS

1 2 3 4 65

7a

7b

8a

8b

9a

9b

10

a

10

b

11

a12

a

7.b. Bron kiest voor scenario waarin de bron consent en contactgegevens behoudt. Bij verzenden van notificaties gaat de Notificatie API contactgegevens en consent ophalen bij bron

8.a. Afspraak rond datacontract en type service/API van bron tav Notificatie API+ foutafhandeling = (integratietraject!)

9.a. Bron ontwikkelt service of API en stelt ter beschikking aan Notificatie API

10.a. Testing betaversie service en gebruik door notificatie API

11.a. Afspraak rond in productiestelling en gebruik van deze service of API voor notificaties ivm dossierstatuswijzigingen in DOSIS.

12.a. In productiestelling

Gebruik van de notificatie API in combinatie met DOSIS: aansluitingsproces (scenario 2)

Aansluiten op DOSIS 16

11

a12

a

NOG TE BOUWEN: NOG ONDERHEVIG AAN WIJZIGINGEN

11

a12

a

1 2 3 4 65

7a

8a

9a

10

a11

a12

a

7b

8b

9b

10b