Page Comparison

Table of Contents

...

Een standaard item op basis van het Once-Only-principe waarbij u de minimale parameters van het formulier opgeeft. De voorwaarde is een CNAME onder http://*.burgerprofiel.be, en de respectievelijke testdomeinen.
Een tweede item met extensies:
- nisCode om aan te geven voor welk lokaal bestuur het formulier van toepassing is
- productId voor het IPDC-nummer
- URLs die niet onder http://burgerprofiel.be vallen, hiervoor is een thirdPartyCookieApi verplicht (zie Aanvraagformulieren Aanvraagmodule - Third-party cookies)

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

_links.embed

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 TEMP_SSO_TOKEN of token (die overeenkomen met het single use SSO token, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/5848175061#Gebruikerscontext-doorgeven-aan-een-Aanvraagmodule

Info
Gebruik deze key indien er geen `fallback` wordt meegegeven.

_links.fallback

De link naar een formulier dat een gebruiker kan openklikken wanneer het formulier niet kan worden geëmbed, bijv. door browser-incompatibiliteit.

Note
Om een fallback-link te gebruiken moeten er een global header en footer geconfigureerd zijn.

Info
Gebruik deze key indien er geen `embed` wordt meegegeven.

_links.thirdPartyCookieApi

Alleen nodig als de formulieren worden aangeboden via een third-party domein, niet indien onder een CNAME van *.formulieren.burgerprofiel.be

Voor meer details, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6180832603/

Aanvraagformulieren

Aanvraagmodule+-+Third-party+cookies#Alternatieve-oplossing:-Third-party-cookie-API-endpoint

_links.ssoTokenRegistationApi

Verplicht voor formulieren die een aangemelde context vereisen (samen met sso.audience, hieronder beschreven).

Geeft aan op welk endpoint de aangemelde context van MBP overgedragen kan worden.

Voor meer details, zie

Aanvraagformulieren

Aanvraagmodule - Authenticatie via Single Sign-on (SSO)

sso.audience

Verplicht wanneer _links.ssoTokenRegistationApi meegegeven wordt.

Geeft aan voor welke doelgroep of “audience” (ACM Client-ID) de token exchange moet gebeuren wanneer de burger het formulier opent.

Note
Voorwaarde: een trust-relatie bij ACM (white-listed) van Mijn Burgerprofiel → klant Zie ook: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6117854932/ACM-integratie#Aanvragen---Provider-API

productId ^*

Het IPDC- productId wordt gebruikt om in IPDC de titel, beschrijving, afleverende dienst, thematiek en meer info-link op te vragen.

nisCode

Voor formulieren die voor een lokale bestuur beschikbaar is.

Voor dienstverleningen op Vlaams niveau komt deze property niet terug - kan vrijblijvend wel worden ingevuld, afhankelijk van de context.
Voor dienstverleningen op lokaal niveau is deze property wel verplicht.

Bijv.

Code Block
"nisCode": "23096"

Info

_links.embed en _links.fallback kunnen in deze combinaties worden gebruikt:

_links.embed en _links.fallback: er is een iframe-integratie dankzij de embed-link, en er wordt in het zijpaneel ook een link naar het extern loket getoond dankzij de fallback-link
wel _links.embed en geen _links.fallback er is een iframe-integratie dankzij de embed-link maar de link naar het extern loket is identiek aan de link voor de iframe (zonder SSO) - let op: het is altijd beter om de fallback-link expliciet te definiëren
geen _links.embed en wel _links.fallback: er is geen iframe-integratie, alleen de knop die direct het extern loket opent

Query parameters

Parameter	Beschrijving
`limit`, `offset`	Zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#Paginering

GET /api/v1/forms-submissions (optioneel)

Code Block

breakoutMode	full-width

{
    "_links": {
      "self": { "href": "https://dienstenleverancier.be/api/v1/form-submissions?limit=10&offset=0" },
      "first": { "href": "https://dienstenleverancier.be/api/v1/form-submissions?limit=10&offset=0" },
      "next": { "href": "https://dienstenleverancier.be/api/v1/form-submissions?limit=10&offset=10" },
      "last": { "href": "https://dienstenleverancier.be/api/v1/form-submissions?limit=10&offset=20" },
    },
    "_pageMetadata": {
      "offset": 0,
      "size": 10,
      "totalItems": 26
    },
   "_embedded": {
      "items": [
        {
          "_links": {
              "embed": { "href": "https://uw-eloket-cname.formulieren.burgerprofiel.be/submission/cff3bebb-dd1c-4937-b335-f6c8c9543cb6?token={TEMP_SSO_TOKEN}", "templated": true },
              "fallback": { "href": "https://uw-eloket-cname.formulieren.burgerprofiel.be/submission/cff3bebb-dd1c-4937-b335-f6c8c9543cb6 },
              "ssoTokenRegistrationApi": { "href": "https://uw-eloket-cname.formulieren.burgerprofiel.be/api/v1/temp-sso-token" }
          },
          "sso": {
            "audience": "93a4b91a-93f4-4cb2-bdc5-14bc53762cef"
          },
          "id": "cff3bebb-dd1c-4937-b335-f6c8c9543cb6",
          "productId": "697"
          "status": "in-progress",
          "created": "2020-08-11T08:34:55.451Z",
          "updated": "2020-08-19T10:58:12.379Z"
        },
        {
          "_links": {
              "embed": { "href": "https://formulieren.loket.vlaanderen.be/submission/80a5af1f-8786-4124-9d60-652e53428a8d?token={TEMP_SSO_TOKEN}", "templated": true },
              "fallback": { "href": "https://formulieren.loket.vlaanderen.be/submission/80a5af1f-8786-4124-9d60-652e53428a8d" },
              "thirdPartyCookieApi": { "href": "https://formulieren.loket.vlaanderen.be/api/v1/third_party_cookies" },
              "ssoTokenRegistrationApi": { "href": "https://formulieren.loket.vlaanderen.be/api/v1/temp-sso-token" }
          },
          "sso": {
            "audience": "d9da076d-3069-481c-9fa7-783ccb84ad61"
          },
          "id": "80a5af1f-8786-4124-9d60-652e53428a8d",
          "productId": "1390",
          "submissionTitle": "Renovatielening voor Structurele Elementen"
          "nisCode": "23096",
          "status": "in-progress",
          "created": "2020-08-11T08:34:55.451Z",
          "updated": "2020-08-19T10:58:12.379Z"
        },
        ...
      ]
    }
  }

...

status: in-progress zodat het formulier tussentijds kan bewaard worden
created: Datum wanneer de instantie van het formulier aangemaakt is
updated: Datum wanneer de laatste wijziging is gebeurd aan de instantie van het formuliersubmissionTitle: Optioneel veld die een specifieke titel geeft aan de submission

Query parameters

Parameter	Beschrijving
`limit`, `offset`	Zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#Paginering

Headers

Zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#CorrelationId-en-RequestId

De X-Correlation-ID en X-Request-ID headers zullen aanwezig zijn op de aanvragen en we verwachten dat de API-implementatie er rekening mee houdt in de responses.

Authenticatie

Voor API’s, zie https://We maken onderscheid tussen de forms API en de form submissions API.

De forms API is verondersteld onafhankelijk te zijn van de ingelogde burger. Deze API moet ook aangeroepen worden in een niet-aangemaalde MBP sessie. Voor dit endpoint worden daar volgende authenticatie middelen ondersteund:

anonymous (publiek)
OAuth2 met client-credentials-grant (meer informatie op https://authenticatie.vlaanderen.be/docs/beveiligen-van-api/oauth-rest/rest-server2server/)
mTLS

De form submissions API moet aangeroepen worden in de context van een aangemelde burger, hiervoor zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#ACM-OAuth-met-burgeridentificatie

Voor Front-end SSO, zie Aanvraagformulieren Aanvraagmodule - Authenticatie via Single Sign-on (SSO)

Afhandeling foutberichten

...

Een aanvraag starten

Inc drawio

imgPageId

zoom	1
simple	0
custContentId	6183060345
pageId	5873176651	custContentId	6183060345
lbox	1
diagramDisplayName	formulieren-sequence.drawio
hiResPreview	0
baseUrl	https://vlaamseoverheid.atlassian.net/wiki
imgPageId	5873176651
diagramName	form-lifecycles.drawio
5873176651	pCenter	1
aspect	E67gfSI1WxzeGBtbC1I_ 1
width	1141
includedDiagram	1
aspectHash	6b6e031c3405ec3e39dad7538d7667c7c25f2438
links	auto
tbstyle	top
height	1091

...

Om de integratie met Mijn Burgerprofiel correct te laten verlopen, moet de embed-pagina bepaalde gebeurtenissen melden aan Mijn Burgerprofiel. Momenteel gebeurt dit aan de hand van het window.postMessage op het parent-window (= Mijn Burgerprofiel). Die gebeurtenissen worden opgevangen om de gebeurtenissen - zoals een formulier indienen - correct te verwerken.

Inc drawio

zoom	1
simple	0
custContentId	6183060345
pageId	5873176651
custContentId	6183060345
lbox	1
diagramDisplayName	formulieren-sequence.drawio
hiResPreview	0
baseUrl	https://vlaamseoverheid.atlassian.net/wiki
imgPageId	5873176651
diagramName	form-lifecycles.drawio	imgPageId	5873176651
pCenter	1
aspect	p2fdbZiMIzNi8GB3PEac 1
width	841
includedDiagram	1
aspectHash	aab47bcc5c555fae86620677b51a64bd056d95f0
links	auto
tbstyle	top
height	1021

...

Versions Compared

Old Version 54

New Version Current

Key

GET /api/v1/forms-submissions (optioneel)

Headers

Authenticatie

Afhandeling foutberichten

Een aanvraag starten