Koppelscenario's Mijn Burgerprofiel - Aanvraagformulieren

Formulieren bouwen met Adobe Experience Manager

Digitaal Vlaanderen biedt een integratie met Adobe Experience Manager. Als u een formulier bouwt met AEM en dat formulier ook via Mijn Burgerprofiel wilt aanbieden, neem dan de volgende stappen:

1. Tag het formulier met ‘Mijn Burgerprofiel’.

2. Voeg het IPDC-productId toe.

3. Publiceer het formulier in AEM.

Éé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:

• IPDC data: productId, titel, beschrijving, afleverende dienst

• de URL naar uw formulier

Formulieren koppelen met Mijn Burgerprofiel via de Provider-API

Om meerdere formulieren te koppelen met Mijn Burgerprofiel of om verdere integratiemogelijkheden te krijgen, zoals formulieren opslaan, een 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:

• 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 v1 - Draft

  • 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 formulieren voldoen aan de vormvereisten zoals omschreven in

    • API-specificaties voor aanbieders van formulieren v1 - Draft

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

  • Een third-party-cookie API endpoint bestaat die voldoet aan deze specificaties: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/5873176651/API-specificaties+voor+aanbieders+van+formulieren+v1+-+Draft#POST%2FGET-%2Fapi%2Fv1%2Fthird-party-cookies

  • De nodige frontend communicatie voorzien is zoals gedocumenteerd in: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/5873176651/API-specificaties+voor+aanbieders+van+formulieren+v1+-+Draft#Frontend-communicatie-voor-ge%C3%ABmbedde-formulieren

  • Ondersteuning voor Frontend Token Exchange om de aangemelde context van Mijn Burgeprofiel naar uw systeem te kunnen doorgeven, volgens deze specificaties: Aanvraagmodule - Authenticatie via Single Sign-on (SSO)

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:

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

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

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