| Table of Contents |
|---|
...
In deze documentatie leest u welke vormvoorschriften verwacht worden van uw API’s 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 Aanvraagformulieren leest u hier: https://vlaamseoverheid.atlassian.net/l/cp/0M5wkCN2
Met vragen of feedback kunt u terecht bij de servicedesk: https://www.vlaanderen.be/servicedesk/ik
...
| 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": "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",
"provider": {
"id": "OVO000106",
"name": "Wonen-Vlaanderen",
"productId": "1390",
"nisCodes": [ "23096", "23038", "23081" ],
"title": "Inname openbaar domein",
"description": "Als u bouwt of verbouwt neemt u soms een deel van de openbare weg in om een container, een steiger, een bouwkraan, ... te plaatsen. Hiervoor moet u een toelating aanvragen."
},
...
]
}
} |
...
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:
nisCodesom aan te geven voor welke lokale besturen het formulier van toepassing isprovideridenname: dit zijn de OVO-code en de naam van de bevoegde overheidURLs die niet onder http://burgerprofiel.be vallen, hiervoor is een
thirdPartyCookieApiverplicht (zie Aanvraagformulieren - Third-party cookies)IPDC-
titleen -descriptionvelden die toelaten de standaard tekst uit IDPC te overschrijven
| 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/Aanvraagformulieren+-+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 Aanvraagformulieren - Authenticatie via Single Sign-on (SSO) | ||||
| 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- | ||||
| Voor formulieren die voor één of meerdere lokale besturen beschikbaar zijn.
Bijv.
|
...