Wat is de Notificatie Bouwsteen?

Onder impuls van het programma Vlaanderen Radicaal Digitaal Informatie Vlaanderen in een generieke bouwsteen die ‘verzenders’ moet toelaten om notificaties van diverse categorieën over een aantal courante notificatiekanalen te verzenden naar ‘bestemmelingen’. Deze bouwsteen neemt de vorm aan van een Restful API beveiligd door middel van OAuth 2.0 , een industriestandaard protocol voor het beveiligen van API’s..

Centraal in de werking van de Notificatiebouwsteen staat het concept van de notificatiebundel. De notificatiebundel bevat, kort samengevat, de inhoud van de notificatie en relevante metadata nodig voor het correct verzenden van de notificatie over één of meerdere notificatiekanalen naar één of meerdere bestemmelingen.

Een notificatiebundel kan via een push mechanisme aan de NotificatieAPI bezorgd worden. In het scenario neemt de verzender het initiatief om de verzending te starten. Bij een push scenario ‘post’ de verzender de notificatiebundel naar de Notificatiebouwsteen volgens bepaalde afspraken.

Schema

bird view op de werking van de Notificatie API

Notificatiecategorieën en notificatiekanalen

Voor het bepalen van de inhoud en de vorm van een notificatiebericht speelt de notificatiecategorie, waartoe het bericht behoort, een cruciale rol. Elke categorie komt met specifieke eigenschappen, bovenop een aantal eigenschappen die het deelt met één of meerdere andere notificatiecategorieën. Momenteel onderscheiden we de volgende categorieën:

Naast de notificatiecategorie heeft ook het kanaal waarlangs de notificatie wordt verzonden, een impact op de inhoud en de vorm van een notificatiebericht. Momenteel worden de volgende notificatiekanalen door de Notificatiebouwsteen ondersteund:

  • Passieve notificatie getoond in een siteheader
  • E-mail (in ontwikkeling)
  • SMS (2019)
  • ...

Integreren op de Notificatiebouwsteen: praktische aspecten

Om de Notificatiebouwsteen te gebruiken als afzender moeten een aantal stappen worden afgelegd, in overleg en met medewerking van het onboarding team voor deze bouwsteen. Grosso modo komt de integratie in de praktijk neer op:

  • De partner maakt zijn keuze over het gewenste integratiescenario op de Notificatiebouwsteen en vult de nodige informatie in op het onboardingformulier. Deze informatie zal worden gebruikt in de PubliekeDienstverleningsConfiguratie.
  • De partner doet aanvraag voor een Geosecure account met de nodige Notificatie rollen ('NotificatieImport') voor de aanmaak van de initiële configuratie en een technische cliënt om de nodige tokens te genereren.
  • Het team Notificatie configureert voor de afzender een PubliekeDienstverleningsConfiguratie in de Notificatiebouwsteen op basis van informatie verzameld tijdens de intake.
  • De partner bouwt de technische integratie met de Notificatiebouwsteen volgens het gekozen scenario: rechtstreekse push van de notificatiebundel of triggeren van een notificatieophaalverzoek.
  • End-to-end testen worden uitgevoerd op de notificatiecategorieën en de kanalen die in de PubliekDienstverleningsConfigurate werden aangemerkt.

Mogelijke integratiescenario’s op de Notificatiebouwsteen

Notificatiekanalen Notificatiecategorie Integratiemethode
Passieve Notificatie Dossierstatus Push vanuit DOSIS (onboarding op DOSIS nodig)
    (Push vanuit systeem partner)
  Vrije Push vanuit systeem partner
  (Algemeen nieuwsbericht) Push vanuit systeem partner
  (GTMF)  
  (Welkomstbericht)  
Actieve Notificatie via e-mail Dossierstatus Push vanuit DOSIS
    (Push vanuit systeem partner)
  Vrije Push vanuit systeem partner
  (Algemeen nieuwsbericht) Push vanuit systeem partner