Versions Compared

Old Version 46

changes.mady.by.user Heidi Vannevel

Saved on

compared with

New Version 47

changes.mady.by.user Heidi Vannevel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

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+-+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 - 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.

nisCodes

Voor formulieren die voor één of meerdere lokale besturen beschikbaar zijn.

  • 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
"nisCodes": [ "23096", "23038", "23081" ]

...

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

Minimale data voor een eenvoudige aansluiting

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.

 

Minimale data nodig voor een eenvoudige aansluiting (met IPDC), die opent 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 alleen de fallback mee te geven, opent dit formulier in een nieuwe tab. Verder zijn hier alleen de volgende elementen vereist:

  • Een unieke id om een random UUID te genereren (deze heeft verder geen betekenis in de set-up)

  • Een productId

 

Minimale data nodig voor een eenvoudige aansluiting die onder *.vlaanderen.be valt (first-party).

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"
}

De embed-property zorgt ervoor dat dit formulier kan worden geëmbed in Mijn Burgerprofiel

Voorbeeld eenvoudige aansluiting voor Fayatbeurs

Opent in een nieuwe tab (dus geen embed in Mijn Burgerprofiel)

...

Formulieren koppelen met Mijn Burgerprofiel

...