Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

Document status

...

Status
colourBlue
titleproposal

...

Version

...

1.0

...

Date

...

Table of Contents

Over deze documentatie

...

  • 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:

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/Aanvraagmodule+-+Authenticatie+via+Single+Sign-on+SSO#Gebruikerscontext-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/AanvraagmoduleAanvraagformulieren+-+Third-party+Party+Cookies#Alternatievecookies#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 Aanvraagmodule 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 ofmeerdere lokale besturen beschikbaar zijn.

Bijv.

Code Block
"nisCodes": [ "23096", "23038", "23081" ]

...

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 Aanvraagformulieren - Authenticatie via Single Sign-on (SSO)

...

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

...

koppelen met Mijn Burgerprofiel

Mijn Burgerprofiel gebruikt de REST-API (zie hierboven) om de dienstverlening van verschillende leveranciers aan te bieden via de lijst met Aanvragen.
Als de gebruiker kiest om een aanvraag te starten, wordt de embed-link (die hierboven beschreven staat) geopend in een zijpaneel.

...