Over deze documentatie

In deze documentatie leest u welke vormvoorschriften verwacht worden van uw API('s) om te kunnen integreren met Mijn Burgerprofiel. Het is een verdere uitwerking van dehttps://vlaamseoverheid.atlassian.net/l/c/LP1ZL8i6.

• Meer informatie over de types aansluitingen op de bouwsteen Aanvraagformulieren leest u hier: https://vlaamseoverheid.atlassian.net/l/cp/0M5wkCN2

• Met vragen of feedback bij een bestaande koppeling kunt u terecht bij de servicedesk: https://www.vlaanderen.be/servicedesk/ik

Gebruikerscontext - Look en feel formulieren

Hier vindt u binnenkort wireframes die u de nodige gebruikerscontext bieden bij de documentatie van de API’s hieronder.

Zie ook: https://vlaamseoverheid.atlassian.net/l/c/LP1ZL8i6.

REST API

GET /api/v1/forms

{
    "_links": {
      "self": { "href": "https://dienstenleverancier.be/api/v1/forms?limit=10&offset=0" },
      "first": { "href": "https://dienstenleverancier.be/api/v1/forms?limit=10&offset=0" },
      "next": { "href": "https://dienstenleverancier.be/api/v1/forms?limit=10&offset=10" },
      "last": { "href": "https://dienstenleverancier.be/api/v1/forms?limit=10&offset=30" }
    },
    "_pageMetadata": {
      "offset": 0,
      "size": 10,
      "totalItems": 35
    },
   "_embedded": {
      "items": [
        {
          "_links": {
              "embed": { "href": "uw-eloket-cname.formulieren.burgerprofiel.be/93a4b91a-93f4-4cb2-bdc5-14bc53762cef?token={TEMP_SSO_TOKEN}" "templated": true },
              "fallback": { "href": "uw-eloket-cname.formulieren.burgerprofiel.be/93a4b91a-93f4-4cb2-bdc5-14bc53762cef" },
              "ssoTokenRegistrationApi": { "href": "uw-eloket-cname.formulieren.burgerprofiel.be/api/v1/temp-sso-token" }
          },
          "sso": {
            "audience": "93a4b91a-93f4-4cb2-bdc5-14bc53762cef"
          },
          "id": "d898fa60-e76f-44bb-89bd-9a468dab2319",
          "productId": "697"
        },
        {
          "_links": {
              "embed": { "href": "formulieren.loket.vlaanderen.be/8350d7ed-ae18-4525-ac2c-abaa49656e3c?token={TEMP_SSO_TOKEN}" "templated": true },
              "fallback": { "href": "formulieren.loket.vlaanderen.be/8350d7ed-ae18-4525-ac2c-abaa49656e3c" },
              "thirdPartyCookieApi": { "href": "formulieren.loket.vlaanderen.be/api/v1/third_party_cookies" },
              "ssoTokenRegistrationApi": { "href": "formulieren.loket.vlaanderen.be/api/v1/temp-sso-token" }
          },
          "sso": {
            "audience": "d9da076d-3069-481c-9fa7-783ccb84ad61"
          },
          "id": "8350d7ed-ae18-4525-ac2c-abaa49656e3c",
          "productId": "1390",
          "nisCodes": [ "23096", "23038", "23081" ]
        },
        ...
      ]
    }
  }

Het bovenstaande codevoorbeeld geeft de volgende 2 items terug:

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

  • nisCodes om aan te geven voor welke lokale besturen 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 - Third-party cookies)

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

Query parameters

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

{
    "_links": {
      "self": { "href": "https://fl-test-eportal.skryv.com/api/v1/form-submissions?limit=10&offset=0" },
      "first": { "href": "https://fl-test-eportal.skryv.com/api/v1/form-submissions?limit=10&offset=0" },
      "next": { "href": "https://fl-test-eportal.skryv.com/api/v1/form-submissions?limit=10&offset=10" },
      "last": { "href": "https://fl-test-eportal.skryv.com/api/v1/form-submissions?limit=10&offset=20" },
    },
    "_pageMetadata": {
      "offset": 0,
      "size": 10,
      "totalItems": 26
    },
   "_embedded": {
      "items": [
        {
          "_links": {
              "embed": { "href": "https://fl-test-eportal.skryv.com/#/80a5af1f-8786-4124-9d60-652e53428a8d" },
              "fallback": { "href": "https://fl-test-eportal.skryv.com/#/80a5af1f-8786-4124-9d60-652e53428a8d" },
              "form": { "href": "https://fl-test-eportal.skryv.com/#/dossier-info/8350d7ed-ae18-4525-ac2c-abaa49656e3c" },
              "thirdPartyCookieApi": { "href": "https://fl-test-eportal.skryv.com/api/v1/third_party_cookies" }
          },
          "id": "80a5af1f-8786-4124-9d60-652e53428a8d",
          "formId": "8350d7ed-ae18-4525-ac2c-abaa49656e3c",
          "status": "in-progress",
          "provider": {
            "id": "OVO000106",
            "name": "Wonen-Vlaanderen",
          },
          "created": "2020-08-11T08:34:55.451Z",
          "updated": "2020-08-19T10:58:12.379Z"
        },
        ...
      ]
    }
  }

Het bovenstaande codevoorbeeld geeft items terug met deze extra extensies:

• status: in progress zodat het formulier tussentijds kan bewaard worden

• provider id en name: de OVO-code en de naam van de bevoegde overheid

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://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#ACM-OAuth-met-burgeridentificatie

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

Afhandeling foutberichten

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

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.

Een aanvraag starten

Lifecycle events

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.

WINDOW_RESIZED event

Zodra de pagina geladen is, moet dit aan Mijn Burgerprofiel worden gemeld, zodat de iframe kan worden getoond (in plaats van de loading state).

Dit event zorgt ervoor dat de formulier-pagina rapporteert over welke reële hoogte/breedte die momenteel heeft (in pixels):

window.parent.postMessage({
  "action": "WINDOW_RESIZED",
  "height": 768,
  "width": 1024
})

Hetzelfde event wordt ook verwacht als er veranderingen zijn in de afmetingen van de pagina, bijvoorbeeld wanneer er content verschuift of wanneer nieuwe velden zichtbaar worden.

Mijn Burgerprofiel gebruikt de informatie om rekening te houden met eventuele overflows, en om indien nodig lay-outaanpassingen te doen.

FORM_INITIALIZED event

Zodra de gebruiker het formulier begint in te vullen, kan er dataverlies zijn als de aanvraag gesloten wordt vooraleer ze bevestigd en ingediend is. Dit event wordt in eerste plaats gebruikt om aan te geven dat de gebruiker interactie heeft gehad met het formulier.

Zodra dit event getriggerd is in de context van een formulier, kan de gebruiker het zijpaneel in Mijn Burgerprofiel niet sluiten zonder een waarschuwing te krijgen.

window.parent.postMessage({
  "action": "FORM_INITIALIZED"
})

FORM_FINISHED event

Wanneer de gebruiker de aanvraag wil onderbreken zonder die ze in te dienen, of wanneer alle stappen in het formulier doorlopen zijn zonder een dossier te starten, kan het formulier een knop tonen om de aanvraag te sluiten.

window.parent.postMessage({
  "action": "FORM_FINISHED"
})

FORM_SUBMITTED event

Wanneer de gebruiker de aanvraag volledig heeft ingevuld, kan ze ingediend worden. Na indiening wordt er een dossier opgestart zodat de gebruiker later de status van de aanvraag kan opvolgen.

Zodra de aanvraag met succes is ingediend bij het loket, moet de pagina dit melden aan Mijn Burgerprofiel. Op basis van dit event wordt het zijpaneel gesloten (zonder extra waarschuwing). De gebruiker wordt naar de overzichtspagina met aanvragen gestuurd, en ziet daar de bevestiging dat de aanvraag ingediend is.

window.parent.postMessage({
  "action": "FORM_SUBMITTED",
  "submissionTitle": "Uw aanvraag is ingediend",
  "submissionMessage": "Loket X verwerkt nu uw aanvraag. U ontvangt een melding wanneer ze in behandeling is.",
  "dosis": "urn://loket.burgerprofiel.be/aanvraag/86-XIOSJP-91352"
})

• submissionTitle en submissionMessage (optioneel) kunnen meegegeven worden om de boodschap in de alert aan te passen.

• dosis kan (optioneel) meegegeven worden om aan te geven wat de dossierbron & dossiernummer zijn van het nieuwe dossier (op die manier kan het relevante dossier opgehaald worden in het aanvragen-overzicht)