Document status |
| ||||||
Version | 1.0 | ||||||
Date |
|
...
| Info |
|---|
Once-Only-principle: minimale input voor een maximaal hergebruik Door het gebruik van IPDC en once-only principes streven we maximaal naar eenvoudige en eenduidige configuraties die de gebruiker een consistente ervaring geven doorheen het platform. De minimaal verpichte velden zijn hieronder aangegeven met * |
Key | Beschrijving | ||||
|---|---|---|---|---|---|
| De link naar het fomulier dat geëmbed wordt in Mijn Burgerprofiel. Conform JSON-HAL kan dit een templated link zijn. Indien het formulier SSO verwacht (zie hieronder), dan kan in de URI template query expansion gedaan worden van
| ||||
| De link naar een formulier dat een gebruiker kan openklikken wanneer het formulier niet kan worden geëmbed, bijv. door browser-incompatibiliteit.
| ||||
| Alleen nodig als de formulieren worden aangeboden via een third-party domein, niet indien onder een CNAME van Voor meer details, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6180832603/Aanvraagmodule+-+Third+Party+Cookies#Alternatieve-oplossing:-Third-party-cookie-API-endpoint | ||||
| Verplicht voor formulieren die een aangemelde context vereisen (samen met Geeft aan op welk endpoint de aangemelde context van MBP overgedragen kan worden. Voor meer details, zie Aanvraagmodule - Authenticatie via Single Sign-on (SSO) | ||||
| Verplicht wanneer Geeft aan voor welke doelgroep of “audience” (ACM Client-ID) de token exchange moet gebeuren wanneer de burger het formulier opent.
| ||||
| Het IPDC- | ||||
| Voor formulieren die voor één ofmeerdere lokale besturen beschikbaar zijn. Bijv.
|
...
Voor API’s, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#ACM-OAuth-met-burgeridentificatie
Voor Front-end SSO, zie Aanvraagmodule - Authenticatie via Single Sign-on (SSO)
Afhandeling foutberichten
Voor een eenvoudigere configuratie kan Aansluitingen een configuratie vragen die bij de formulieren aggregator kan ingeregeld worden, zie ook deze Jira template voor het aanmaken van een ticketje bij het dev-team
Minimale data die nodig is voor een eenvoudige aansluiting (met IPDC). Dit gaat open in een nieuwe tab:
| 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 gaat deze open in een nieuwe tab. Enkel een unieke id (deze heeft verder geen betekenis in deze setup, gewoon een random UUID genereren) en een productId is vereist.
Een eenvoudig aansluiting toevoegen die onder *.vlaanderen.be valt (first-party). Deze formulieren kunnen ge-embed op Mijn Burgerprofiel worden, door de embed property toe te voegen:
| 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"
} |
Voorbeeld eenvoudige aansluiting voor Fayatbeurs. Openen in een nieuwe tab (geen embed) en met overschrijving van IPDC properties (af te raden, IPDC zou leidend moeten zijn):
| 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."
} |
Formulieren integreren in Mijn Burgerprofiel
...