Formulieren bouwen met Adobe Experience Manager
Er is reeds integratie voorzien met de AEM van Aanvraagmodule. Wenst u het formulier op Mijn Burgerprofiel zichtbaar te maken dan dient u de volgende stappen te ondernemen:
...
stap 1 Tag het formulier met ‘Mijn Burgerprofiel’
...
stap 2 IPDC productid toevoegen
...
Table of Contents | ||||
---|---|---|---|---|
|
De verschillende manieren om aanvraagformulieren te koppelen met Mijn Burgerprofiel worden ook aangeboden in het aansluitingsformulier. Hieronder leest u meer details over elk van die opties.
Over de Formulierentool van Digitaal Vlaanderen
Met de Formulierentool van Digitaal Vlaanderen kunt u zelf formulieren bouwen die ook via Mijn Burgerprofiel kunnen aangeboden worden. Het is een laagdrempelige oplossing met sjablonen om een formulier te bouwen. U kunt ervoor kiezen om het formulier aan te bieden via Mijn Burgerprofiel of om het te integreren in uw eigen dienstverlening. Meer informatie: https://www.vlaanderen.be/digitaal-vlaanderen/onze-oplossingen/formulierentool.
Info |
---|
Lees de documentatie bij de Formulierentool Digitaal Vlaanderen. |
Over de Aanvraagmodule
Met de Aanvraagmodule van Digitaal Vlaanderen kunt u gebruikers dienstverlening laten aanvragen in Mijn Burgerprofiel door:
1 formulier met beperkte integratiemogelijkheden te koppelen met Mijn Burgerprofiel.
meerdere formulieren te koppelen met Mijn Burgerprofiel met meer integratiemogelijkheden. U stelt hiervoor een API ter beschikking van Mijn Burgerprofiel met een lijst van beschikbare formulieren
Formulieren bouwen met de formulierentool van Digitaal Vlaanderen
Digitaal Vlaanderen biedt een integratie van formulieren met een eigen formulierentool.
Als u een formulier bouwt met die formulierentool en dat formulier ook via Mijn Burgerprofiel wilt aanbieden, vul het aansluitingsformulier in en het team Aansluitingen Mijn Burgerprofiel neemt contact op met u. Met vragen kunt u altijd terecht op aansluitingen.mijnburgerprofiel@vlaanderen.be.
Info |
---|
Met vragen of feedback bij een bestaande koppeling kunt u terecht bij de servicedesk: https://www.vlaanderen.be/servicedesk/ik |
Één formulier aansluiten met beperkte integratiemogelijkheden (Aanvraagmodule)
Wanneer u een enkel formulier wenst aan te sluiten op wilt koppelen met Mijn Burgerprofiel omdat u:
Niet kan of niet wenst een API aan te bieden geen API wil of kunt aanbieden aan Mijn Burgerprofiel die een lijst van beschikbare formulieren voor een burger teruggeeft
Geen filter mogelijkheden dient te hebben
Die opent
geen filtermogelijkheden nodig hebt
uw formulier in een aparte tab wil openen
Hiervoor … dan is er hiervoor een vereenvoudigde aansluiting mogelijk. We behouden dit voor aansluitingen die een enkel formulier aanbieden.
We hebben van u nodig:
...
Bezorg ons in dit geval de volgende informatie in het aansluitingsformulier:
IPDC-informatie: productId, titel, beschrijving, afleverende dienst)
de URL naar uw formulier
Uw formulier dient nog steeds te voldoen aan de vormvoorwaarden
Formulieren aansluiten via de Provider API
...
Formulieren koppelen met Mijn Burgerprofiel via de Form Provider-API (Aanvraagmodule)
Om meerdere formulieren te koppelen met Mijn Burgerprofiel of om verdere integratiemogelijkheden te krijgen, zoals formulieren opslaan, een integratie met DOSIS, … moet u een API ter beschikking stellen van Mijn Burgerprofiel met een lijst van beschikbare formulieren (en optioneel ingediende formulieren) voor een burger teruggeeftburgers.
We hebben van u Concreet hebben we de volgende zaken nodig:
De URL naar uw Provider API endpoint voor het ophalen van om de beschikbare formulieren (en optioneel endpoint voor het ophalen van de ingediende formulieren)
U voorziet een API voor het opvragen van beschikbare formulieren voor een burger die voldoet aan de specificaties:op te halen. Optioneel ook een endpoint om de ingediende formulieren op te halen. Deze API moet voldoen aan de specificaties zoals omschreven in
(sectie “GET /api/v1/forms”)API-specificaties voor aanbieders van formulieren
https://vlaamseoverheid.atlassian.net/wikil/spaces/IKPubliek/pages/5873176651/API+specifications+for+form+providers+EN+v2+-+Draft#GET-/api/v1/forms (sectie “GET /api/v1/forms”)cp/Af2dHdRS
Uw ACM clientId ClientId - deze dient verplicht met een inkomende trustrelatie te hebben met Mijn Burgerprofiel (zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6117854932/ACM+Integratie+Informatie#Aanvragen---Provider-API). U krijgt een Token Exchange token
binnenvanuit Mijn Burgerprofiel met daarin de
rrn
-claimOm het embeddable te maken van uw formulieren dient ute kunnen embedden zorgt u ervoor dat:
De aangeboden formulieren dienen te voldoen API voldoet aan de vormvoorwaarden.Een third-party-cookie API endpoint voorzien die voldoet aan de specificaties: vormvereisten zoals omschreven in
wikispaces/IKPubliek/pages/5873176651/API+specifications+for+form+providers+EN+v2+-+Draft#POST/GET-/api/v1/third-party-cookies (sectie “POST/GET /api/v1/third-party-cookies”)Er een third-party-cookie API endpoint bestaat die voldoet aan deze specificaties: Aanvraagmodule - Third-party cookies > bij voorkeur de CNAME-oplossing
De nodige frontend communicatie voorzien is zoals gespecifieerdgedocumenteerd in: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/5873176651/API-specificaties+specificationsvoor+foraanbieders+form+providers+EN+v2+-+Draft#Frontend-communication-with-form-embedsvan+formulieren#Formulieren-integreren-in-Mijn-Burgerprofiel
Ondersteuning voor Frontend Token Exchange voor het uitwisselen van de ingelogde om de aangemelde context van Mijn Burgeprofiel naar uw systeem , volgende de te kunnen doorgeven, volgens deze specificaties: Aanvraagmodule - Authenticatie via Single Sign-on (SSO)
Minimale data voor een eenvoudige aansluiting (voorbeelden)
Voor een eenvoudigere configuratie kan team Aansluitingen een configuratie vragen die bij de formulierenaggregator kan worden aangemaakt.
Info |
---|
Zie ook deze Jira template om een ticket aan te maken bij het team Development. |
Eenvoudige aansluiting die opent in een nieuwe tab
Hieronder staat de minimale data die nodig is voor een eenvoudige aansluiting met IPDC. Het formulier opent in een nieuwetab:
Code Block |
---|
{
"_links": {
"fallback": { "href": "willekeurig-eloket.vlaanderen.be/url-naar-formulier-met-global-header" },
},
"id": "ee5d582c-5c94-4f62-9f6b-424c41e129f7",
"productId": "1456"
} |
Door enkel de fallback
mee te geven, opent het formulier in een nieuwe tab. Alleen een unieke id
(deze heeft verder geen betekenis in deze set-up, gewoon een “unique identifier” genereren) en een productId
zijn vereist.
Eenvoudige aansluiting geëmbed in Mijn Burgerprofiel
Hieronder staat de data die nodig is om een eenvoudige aansluiting toe te voegen dat onder *.vlaanderen.be valt (first-party). Door de embed
-property toe te voegen kunnen deze formulieren geëmbed worden op Mijn Burgerprofiel:
Code Block |
---|
{
"_links": {
"embed": { "href": "willekeurig-eloket.vlaanderen.be/url-naar-formulier" },
"fallback": { "href": "willekeurig-eloket.vlaanderen.be/url-naar-formulier-met-global-header" },
},
"id": "ee5d582c-5c94-4f62-9f6b-424c41e129f7",
"productId": "1456"
} |
Voorbeeldcode formulier dat opent in een nieuwe tab
Voorbeeld eenvoudige aansluiting voor Fayat-beurs die opent in een nieuwe tab (zonder embed)
Code Block |
---|
{
"_links": {
"fallback": { "href": "https://fayatbeurzen.vlaanderen.be/" },
},
"id": "9a283d7e-c350-45b5-aa14-0f5639d45425",
"title": "Fayatbeurs",
"provider": {
"id": "OVO000032",
"name": "Departement Kanselarij en Buitenlandse Zaken"
},
"description": "Wilt u na uw masterdiploma verder studeren aan een buitenlandse topinstelling? En tegelijk Vlaanderen mee op de kaart zetten in het buitenland? Dan is een Fayatbeurs misschien iets voor u."
} |