🔗 Integratiescenario's

Over de Aanvraagmodule

Met de Aanvraagmodule integreert u verschillende types formulieren waarmee gebruikers dienstverlening kunnen aanvragen in een digitaal loket.

U kunt die formulieren eerst zelf bouwen met de Formulierentool van Digitaal Vlaanderen of met een andere formulierenbouwer in uw organisatie.

Open

Overzicht aanvraagmodule

Aanvraagformulieren integreren in uw digitale diensten kan als volgt:

• Via een vereenvoudigde aansluiting met beperkte integratiemogelijkheden als u een beperkt aantal formulieren hebt

• Via een API die een lijst met beschikbare formulieren kan aanbieden als u meerdere formulieren in één keer wilt koppelen en meer integratiemogelijkheden nodig hebt.

Integratie-opties

Één formulier aansluiten met beperkte integratiemogelijkheden

Wanneer u één formulier wilt koppelen met Mijn Burgerprofiel dan kunt u kiezen voor een vereenvoudigde aansluiting, waarvoor geen API nodig is. Bezorg ons in dat 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

Wilt u meerdere formulieren koppelen met Mijn Burgerprofiel of extra mogelijkheden zoals formulieren opslaan of een integratie met DOSIS? Dan 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 form 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

  • API-specificaties voor aanbieders van formulieren | GET /api/v1/formsPreview

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

• Uw ACM ClientId - verplicht met een inkomende trustrelatie met Mijn Burgerprofiel (zie 🔑 ACM-integratie | Aanvragen Provider APIPreview). U krijgt een Token Exchange token vanuit Mijn Burgerprofiel met daarin de rrn-claim

• Om uw formulieren te kunnen integreren (embedden) in Mijn Burgerprofiel zorgt u ervoor dat:

  • De aangeboden API voldoet aan de specificaties zoals omschreven in

    • API-specificaties voor aanbieders van formulierenPreview

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

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

  • De nodige frontend communicatie voorzien is zoals gedocumenteerd in: API-specificaties voor aanbieders van formulieren | Formulieren integreren in Mijn BurgerprofielPreview

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

Codevoorbeelden voor een eenvoudige integratie

Voor een eenvoudigere configuratie kan team Aansluitingen een configuratie laten aanmaken in de formulierenaggregator.

Eenvoudige integratie die opent in een nieuwe tab

Hieronder staat de minimale data die nodig is voor een eenvoudige integratie van een formulier voor een bepaald IPDC-product/-dienst. Het formulier opent in een nieuwe tab:

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.

Hieronder vindt u de data die nodig is om een eenvoudige aansluiting toe te voegen voor een Fayat-beurs. Het formulier opent in een nieuwe tab (geen embed).

Eenvoudige integratie in Mijn Burgerprofiel

Hieronder vindt u de data die nodig is om een eenvoudige aansluiting toe te voegen onder het domein *.vlaanderen.be (first-party) valt (first-party). Door de embed-property toe te voegen wordt het formulier geïntegreerd getoond in Mijn Burgerprofiel: