⬆️ Upgraden van global header versie 4 naar 5

1 Checklist
2 Technische migratiegids
- 2.1 Verwijder client library script links
- 2.2 Verwijder installeerbare packages via npm of yarn
- 2.3 Update Embed script links
- 2.4 Update API-gebruik
  - 2.4.1 Gewijzigd sessiebeheer
  - 2.4.2 Gewijzigd profielbeheer
- 2.5 Toegang tot window.globalHeaderClient
- 2.6 Update styling en rendering
3 Update widgets URL’s
4 Upgrade oudere headers (legacy) naar v5
5 Hulp nodig?

Checklist

Checklist voor de upgrade van de global header widget naar de meest recente versie. U vindt voor elke check hieronder meer informatie.

Verwijder de client library of polyfill scripts Verwijder de installeerbare packages via npm of yarn Update de embed script links met het juiste versienummer (v1 → v2) Update het gebruik van de `window.globalHeaderClient`-API en maak de nodige wijzigingen in Sessiebeheer Profielbeheer Verifieer de toegang tot `window.globalHeaderClient` Controleer de styling en rendering

Verwijder de client library of polyfill scripts Verwijder de installeerbare packages via npm of yarn Update de embed script links met het juiste versienummer (v1 → v2) Update het gebruik van de `window.globalHeaderClient`-API en maak de nodige wijzigingen in Sessiebeheer Profielbeheer Verifieer de toegang tot `window.globalHeaderClient` Controleer de styling en rendering

Technische migratiegids

🛠️ Zie ook: Global Header - v2.0.26 . (EN)

🛠️ Zie ook: Global Header - v2.0.26 . (EN)

Verwijder client library script links

U hoeft geen client library of polyfill script links meer op te nemen in de HTML. Toegang tot het window.globalHeaderClient-object wordt automatisch gegeven zodra het embed script of het entry script is geladen. 💡 Zie ook 🔧 De global header integreren in uw website/applicatie .

Verwijder installeerbare packages via npm of yarn

Alle functionaliteiten zijn voortaan toegankelijk door script tags direct op te nemen in de <head>-of <body>-sectie van de HTML.

Update Embed script links

Gebruikt u de embed script-methode in uw website, update het versienummer van de src URL van v1 naar v2.

Update API-gebruik

De window.globalHeaderClient-API is geüpdatet in versie 5.

💡 Zie ook globalHeaderClient-sectie in de technische documentatie (EN) voor gedetailleerde informatie over de nieuwe methoden en hun parameters.

Bekijk alle instanties waar je interactie hebt met window.globalHeaderClient.
Update je code om overeen te komen met de nieuwe GlobalHeaderClient-methoden en hun signatures.
Besteed speciale aandacht aan asynchrone methoden die nu promises retourneren.

Widget v4	Widget v5

Widget v4	Widget v5

Gewijzigd sessiebeheer

De global header houdt geen aparte sessiestatus meer bij. Dat betekent:

geen inactiviteitscontroles
geen achtergrondoproepen voor aanvullende sessiedata
geen aparte sessionStorage

Gewijzigd profielbeheer

Vervang alle instanties van de configure-methode door de setProfile-methode in het accessMenu
Verwijder eventuele afhankelijkheden van de loginRedirectUrl-parameter
(optioneel) Gebruik het nieuwe idpData-object om gebruikersprofielbeheer te verbeteren door relevante gebruikersdetails op te nemen, bijv. de naam van de gebruiker als die is aangemeld

Widget v4	Widget v5

Widget v4	Widget v5

Toegang tot `window.globalHeaderClient`

Het window.globalHeaderClient-object is altijd toegankelijk, ongeacht of u de embed script- of de entry script-methode gebruikt.

Update styling en rendering

Controleer of de widget correct wordt getoond in alle ondersteunde browsers.

Update widgets URL’s

Omgeving	Nieuwe URL	Oude URL	Voor wie?

Omgeving	Nieuwe URL	Oude URL	Voor wie?
TNI	`https://widgets.tni-vlaanderen.be`	`https://tni.widgets.burgerprofiel.dev-vlaanderen.be`	Voor afnemers van de global header
Productie	`https://widgets.vlaanderen.be` `https://widgets.vlaanderen.be/api/v.../widget/`	`https://prod.widgets.vlaanderen.be`	Voor afnemers van de global header
Test	`https://widgets.test-vlaanderen.be` `https://widgets.tni-vlaanderen.be/api/v.../widget/`	`https://test.widgets.burgerprofiel.dev-vlaanderen.be`	enkel voor intern gebruik
Beta	`https://widgets.beta-vlaanderen.be`	`https://beta.widgets.burgerprofiel.dev-vlaanderen.be`	enkel voor intern gebruik

Upgrade oudere headers (legacy) naar v5

@Vincent Sennesael @Maarten Vansteenkiste welke richtlijnen geven we hier? Doen we dit via Servicedesk + communicatie?

Hulp nodig?

🤝 Hulp nodig? Kom gerust langs op ons technisch spreekuur.

🤝 Hulp nodig? Kom gerust langs op ons technisch spreekuur.

Documentatie bouwstenen digitale loketten