| Table of Contents |
|---|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"_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": "https://uw-eloket-cname.formulieren.burgerprofiel.be/93a4b91a-93f4-4cb2-bdc5-14bc53762cef?token={TEMP_SSO_TOKEN}", "templated": true },
"fallback": { "href": "https://uw-eloket-cname.formulieren.burgerprofiel.be/93a4b91a-93f4-4cb2-bdc5-14bc53762cef" },
"ssoTokenRegistrationApi": { "href": "https://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": "https://formulieren.loket.vlaanderen.be/8350d7ed-ae18-4525-ac2c-abaa49656e3c?token={TEMP_SSO_TOKEN}" "templated": true },
"fallback": { "href": "https://formulieren.loket.vlaanderen.be/8350d7ed-ae18-4525-ac2c-abaa49656e3c" },
"thirdPartyCookieApi": { "href": "https://formulieren.loket.vlaanderen.be/api/v1/third_party_cookies" },
"ssoTokenRegistrationApi": { "href": "https://formulieren.loket.vlaanderen.be/api/v1/temp-sso-token" }
},
"sso": {
"audience": "d9da076d-3069-481c-9fa7-783ccb84ad61"
},
"id": "8350d7ed-ae18-4525-ac2c-abaa49656e3c",
"productId": "1390",
"nisCodesnisCode": [ "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:
nisCodesnisCodeom aan te geven voor welke lokale besturen welk lokaal bestuur het formulier van toepassing isproductIdvoor het IPDC-nummerURLs die niet onder http://burgerprofiel.be vallen, hiervoor is een
thirdPartyCookieApiverplicht (zie Aanvraagformulieren Aanvraagmodule - Third-party cookies)
| 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 | ||||
|---|---|---|---|---|---|
| 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
| ||||
| De link naar een formulier dat een gebruiker kan openklikken wanneer het formulier niet kan worden geëmbed, bijv. door browser-incompatibiliteit.
| ||||
| Alleen nodig als de formulieren worden aangeboden via een third-party domein, niet indien onder een CNAME van Voor meer details, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6180832603/ |
Aanvraagmodule+-+Third-party+cookies#Alternatieve-oplossing:-Third-party-cookie-API-endpoint | |
| Verplicht voor formulieren die een aangemelde context vereisen (samen met Geeft aan op welk endpoint de aangemelde context van MBP overgedragen kan worden. Voor meer details, zie |
| Verplicht wanneer Geeft aan voor welke doelgroep of “audience” (ACM Client-ID) de token exchange moet gebeuren wanneer de burger het formulier opent.
| ||
| Het IPDC- |
nisCodes
| Voor formulieren die voor |
een lokale |
bestuur beschikbaar |
is.
Bijv.
|
|
|
|
| Info |
|---|
|
Query parameters
Parameter | Beschrijving |
|---|---|
|
productId
1 of meerdere IPDC-productcodes
| Info |
|---|
Bij meerdere productcodes wordt de parameter meerdere keren herhaald: |
nisCode
1 of meerdere niscodes
| Info |
|---|
Bij meerdere niscodes wordt de parameter meerdere keren herhaald: |
Als de niscode niet wordt meegegeven, worden alleen de Vlaamse dienstverlening(en) teruggegeven.
Wordt de niscode wel meegegeven, dan worden zowel de Vlaamse als de lokale dienstverleningen, die voldoen aan de niscode-voorschriften, teruggegeven.
...
| breakoutMode | full-width |
|---|
...
GET /api/v1/forms-submissions (optioneel)
| Code Block | ||
|---|---|---|
| ||
{ "_links": { "self": { "href": "https://dienstenleverancier.be/api/v1/form-submissions?limit=10&offset=0" }, "first": { "href": "https://dienstenleverancier.be/api/v1/form-submissions?limit=10&offset=0" }, "next": { "href": "https://dienstenleverancier.be/api/v1/form-submissions?limit=10&offset=10" }, "selflast": { "href": "https://fl-test-eportal.skryv.comdienstenleverancier.be/api/v1/form-submissions?limit=10&offset=020" }, }, "first_pageMetadata": { "hrefoffset": "https://fl-test-eportal.skryv.com/api/v1/form-submissions?limit=10&offset=0" },0, "size": 10, "totalItems": 26 }, "next_embedded": { "href "items": "https://fl-test-eportal.skryv.com/api/v1/form-submissions?limit=10&offset=10" },[ { "_links": { "lastembed": { "href": "https://fluw-testeloket-eportalcname.formulieren.skryvburgerprofiel.combe/api/v1/form-submissions?limit=10&offset=20" }, },submission/cff3bebb-dd1c-4937-b335-f6c8c9543cb6?token={TEMP_SSO_TOKEN}", "templated": true }, "_pageMetadata": { "offsetfallback": 0, "size": 10, { "href": "https://uw-eloket-cname.formulieren.burgerprofiel.be/submission/cff3bebb-dd1c-4937-b335-f6c8c9543cb6 }, "totalItems": 26 }, "_embeddedssoTokenRegistrationApi": { "items": [ {"href": "https://uw-eloket-cname.formulieren.burgerprofiel.be/api/v1/temp-sso-token" } }, "_linkssso": { "embedaudience": { "href": "https://fl-test-eportal.skryv.com/#/80a5af1f-8786-4124-9d60-652e53428a8d" },"93a4b91a-93f4-4cb2-bdc5-14bc53762cef" }, "fallback": { "hrefid": "https://fl-test-eportal.skryv.com/#/80a5af1f-8786-4124-9d60-652e53428a8d" },cff3bebb-dd1c-4937-b335-f6c8c9543cb6", "productId": "697" "form": { "hrefstatus": "https://fl-test-eportal.skryv.com/#/dossier-info/8350d7ed-ae18-4525-ac2c-abaa49656e3c" },in-progress", "created": "2020-08-11T08:34:55.451Z", "thirdPartyCookieApi": { "hrefupdated": "https://fl-test-eportal.skryv.com/api/v1/third_party_cookies" }2020-08-19T10:58:12.379Z" }, { "id": "80a5af1f-8786-4124-9d60-652e53428a8d", "_links": { "formId": "8350d7ed-ae18-4525-ac2c-abaa49656e3c", "statusembed": { "href": "in-progresshttps://formulieren.loket.vlaanderen.be/submission/80a5af1f-8786-4124-9d60-652e53428a8d?token={TEMP_SSO_TOKEN}", "templated": true }, "provider": { "fallback": { "idhref": "OVO000106"https://formulieren.loket.vlaanderen.be/submission/80a5af1f-8786-4124-9d60-652e53428a8d" }, "namethirdPartyCookieApi": { "Wonen-Vlaanderenhref", : "https://formulieren.loket.vlaanderen.be/api/v1/third_party_cookies" }, }, "ssoTokenRegistrationApi": { "createdhref": "2020-08-11T08:34:55.451Z", https://formulieren.loket.vlaanderen.be/api/v1/temp-sso-token" } "updated": "2020-08-19T10:58:12.379Z" }, }, "sso": { ... ]"audience": "d9da076d-3069-481c-9fa7-783ccb84ad61" }, } |
Het bovenstaande codevoorbeeld geeft items terug met deze extra extensies:
status: in progress zodat het formulier tussentijds kan bewaard wordenprovider idenname: de OVO-code en de naam van de bevoegde overheid
Headers
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
...
"id": "80a5af1f-8786-4124-9d60-652e53428a8d",
"productId": "1390"
"nisCode": "23096",
"status": "in-progress",
"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-progresszodat het formulier tussentijds kan bewaard wordencreated: Datum wanneer de instantie van het formulier aangemaakt isupdated: Datum wanneer de laatste wijziging is gebeurd aan de instantie van het formulier
Query parameters
Parameter | Beschrijving |
|---|---|
|
Headers
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
We maken onderscheid tussen de forms API en de form submissions API.
De forms API is verondersteld onafhankelijk te zijn van de ingelogde burger. Deze API moet ook aangeroepen worden in een niet-aangemaalde MBP sessie. Voor dit endpoint worden daar volgende authenticatie middelen ondersteund:
anonymous (publiek)
OAuth2 met client-credentials-grant (meer informatie op https://authenticatie.vlaanderen.be/docs/beveiligen-van-api/oauth-rest/rest-server2server/)
mTLS
De form submissions API moet aangeroepen worden in de context van een aangemelde burger, hiervoor zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#ACM-OAuth-met-burgeridentificatie
Voor Front-end SSO, zie Aanvraagformulieren Aanvraagmodule - Authenticatie via Single Sign-on (SSO)
Afhandeling foutberichten
...
Een aanvraag starten
| Inc drawio | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
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.
| Inc drawio | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...