Koppelscenario's Mijn Burgerprofiel - Aanvraagformulieren

De verschillende manieren om aanvraagformulieren te koppelen met Mijn Burgeprofiel worden ook aangeboden in het aansluitingsformulier. Hieronder leest u meer details over elk van die opties.

Positionering Formulierentool Digitaal Vlaanderen vs. de Aanvraagmodule

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.

Één formulier aansluiten met beperkte integratiemogelijkheden

Wanneer u een enkel formulier wilt koppelen met Mijn Burgerprofiel omdat u:

• geen API wil of kunt aanbieden aan Mijn Burgerprofiel

• geen filtermogelijkheden nodig hebt

• uw formulier in een aparte tab wil openen

… dan is hiervoor een vereenvoudigde aansluiting mogelijk. Bezorg ons in dit geval de volgende informatie in het aansluitingsformulier:

• IPDC-informatie: productId, titel, beschrijving, afleverende dienst

• de URL naar uw formulier

Formulieren koppelen met Mijn Burgerprofiel via de Form Provider-API

Om meerdere formulieren te koppelen met Mijn Burgerprofiel of om verdere integratiemogelijkheden te krijgen, zoals formulieren opslaan, een minimale integratie met DOSIS, … moet u een API ter beschikking stellen van Mijn Burgerprofiel met een lijst van beschikbare formulieren (en optioneel ingediende formulieren) voor burgers.

Concreet hebben we de volgende zaken nodig:

• De URL naar uw Provider API endpoint om de beschikbare formulieren 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/l/cp/Af2dHdRS

• Uw ACM ClientId - verplicht met een inkomende trustrelatie 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 vanuit Mijn Burgerprofiel met daarin de rrn-claim

• Om uw formulieren te kunnen embedden zorgt u ervoor dat:

  • De aangeboden API voldoet aan de vormvereisten zoals omschreven in

    • API-specificaties voor aanbieders van formulieren

    • https://vlaamseoverheid.atlassian.net/l/cp/Af2dHdRS

  • Er een third-party-cookie API endpoint bestaat die voldoet aan deze specificaties: Aanvraagformulieren - Third-party cookies > bij voorkeur de CNAME-oplossing

  • De nodige frontend communicatie voorzien is zoals gedocumenteerd in: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/5873176651/API-specificaties+voor+aanbieders+van+formulieren#Formulieren-integreren-in-Mijn-Burgerprofiel

  • Ondersteuning voor Frontend Token Exchange om de aangemelde context van Mijn Burgeprofiel naar uw systeem te kunnen doorgeven, volgens deze specificaties: Aanvraagformulieren - 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.

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 nieuwe tab:

{
  "_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:

{
  "_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)

      {
        "_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."
      }