Aanbieder
De aanbieder verstuurt de notificaties naar de bestemmeling.
Afzender
De afzender is de eigenaar van de notificatie, de partij in wiens naam de notificaties worden verstuurd. Dit kan dezelfde organisatie zijn als de aanbieder, maar kan ook verschillen. Zo kan een lokaal bestuur (als afzender) de opdracht geven aan een dienstenleverancier (de aanbieder) om een notificatie te versturen.
Een afzender moet altijd een OrganisatieNaam hebben.
Afzender mailnotificaties
Mailnotificaties zijn “actieve notificaties”. Deze e-mails worden verstuurd vanuit no-reply-mailadressen, afhankelijk van het type bestemmeling.
Type bestemmeling | No-reply mailadres |
|---|---|
RijksRegisterNummer | |
PersoonMetContactInfo | |
OrganisatieMetContactInfo |
Agent
Agent is de verzamelnaam van alle types bestemmelingen: burgers, ondernemingen, verenigingen, lokale besturen, …
Bestemmeling
De bestemmeling is de ontvanger van de notificaties.
Beheer contactvoorkeuren
Om actieve of mailnotificaties te sturen, ligt het beheer van de contactgegevens bij:
Digitaal Vlaanderen beheert de contactgegevens en toestemming bij de contactvoorkeuren van Mijn Burgerprofiel. De bron geeft alleen een RRN mee voor burgers, of een KBO voor ondernemingen.
De bron beheert de contactgegevens en de toestemming (opt-in en opt-out) zelf. Voor elke notificatie stuurt de bron via de API de e-mailadressen door als onderdeel van de notificatiebundel. De bron voorziet ook zelf een opt-out optie voor gebruikers.
Bestemmelingtypes
Om een burger te bereiken met contactvoorkeuren van Mijn Burgerprofiel
Identificatie: RijksRegisterNummer
Mail verstuurd van noreply@burgerprofiel.vlaanderen.be
Om een burger te bereiken met contactvoorkeuren van de afzender
Identificatie: e-mailadres uit de contactvoorkeuren van de afzender
Mail verstuurd van noreply@burgerprofiel.vlaanderen.be
Om een organisatie/ondernemer te bereiken met contactvoorkeuren van de afzender:
Identificatie: e-mailadres uit de contactvoorkeuren van de afzender en ondernemingsnummer
Mail verstuurd van mail from = noreply@notificaties.vlaanderen.be
Beschikbaar voor volgende kanalen
Passief: passieve notificatie en melding in Mijn Burgerprofiel
Actief: e-mail op basis van de contactvoorkeuren zoals beheerd in Mijn Burgerprofiel
Categorieën
Templates om de vormgeving van de notificaties consistent te houden. Zo bestaan er bijv. templates (codes) voor:
Vrije notificatie - Code: “VrijeNotificatie”
carolien.willen christophe.vanderhaeghen welke andere categorieën vermelden we hier nog?
Endpoints
Base lines:
TNI:
https://notificaties.api.tni-vlaanderen.be/PROD:
https://notificaties.api.vlaanderen.be/
De endpoints om de notificatiebundel te versturen:
TNI:
https://notificaties.api.tni-vlaanderen.be/api/v2/notificatiesPROD:
https://notificaties.api.vlaanderen.be/api/v2/notificaties
Op het endpoint in productie zit er “rate limiting” van 1800 calls/minuut.
In de Swagger-documentatie zijn de API-endpoints opgesplitst op basis van actor: afzender of agent
Kanalen
De manier waarop de bestemmeling wordt bereikt. Notificaties beschikbaar maken kan via meerdere kanalen:
Passieve notificaties, getoond in de global header van de site en in de Brievenbus van Mijn Burgerprofiel
E-mailnotificaties naar de bestemmeling van de notificatie
Minderjarigen
Notificaties kunnen ook worden verstuurd naar minderjarigen van 12 jaar en ouder. Het gaat over notificaties voor een beperkte lijst van IPDC-producten. Voor welke IPDC-producten ook meldingen voor minderjarigen worden gestuurd, is gedefinieerd in de IPDC-catalogus.
Notificatiebundel
Het pakket data dat via de REST-API wordt verstuurd om 1 notificatie naar 1 of meerdere bestemmelingen te versturen.
De notificatiebundel bevat de inhoud van de notificatie en relevante metadata nodig om die notificatie correct te verzenden over één of meerdere notificatiekanalen naar één of meerdere bestemmelingen.
Let op: de bundel bevat 1 boodschap - om meerdere boodschappen door te geven via notificaties, zijn er dus meerdere bundels nodig.
Eigenschap | Omschrijving |
ID | Identificatie van de notificatiebundel |
Transactie-ID | ID om meerdere notificaties voor dezelfde bestemmeling te koppelen - zo worden notificaties met dezelfde transactie-ID in een frontend (zoals Mijn Burgerprofiel) samen in dezelfde historiek getoond. |
Bestemmelingen | Identificatie van de persoon voor wie de notificatie bestemd is - kan een e-mailadres of ID (rijksregisternummer) zijn. |
Categorie | Templates om de vormgeving van de notificaties consistent te houden. |
Kanalen | Keuze tussen passieve of e-mailnotificaties |
Product-ID | Verwijzing naar het gekoppelde IPDC-product. |
Merkcode christophe.vanderhaeghen checken | Een alias, bijv. :
|
Vervaldatum | Alleen voor passieve notificaties - die worden na de vervaldatum niet meer getoond in Mijn Burgerprofiel. Bepaal de vervaldatum vooraf. Zodra de notificatie is verstuurd, kan de bron deze datum niet meer wijzigen. |
Verzenddatum | Om de notificatie niet meteen te versturen naar de bestemmeling - de notificatie wordt pas verzonden op deze datum. De verzenddatum mag maximaal 3 maanden in de toekomst liggen. |
Notificaties
Digitale berichten die Vlaamse overheidsdiensten of lokale besturen versturen naar burgers of ondernemers. De berichten zijn beschikbaar in de Brievenbus van Mijn Burgerprofiel. De notificaties worden verstuurd via een RESTful API die beveiligd is met het OAuth 2.0-protocol.
Scope
De scope waaraan het access token toegang zal geven. Voor de Notificaties-API zijn de scopes:
NotificatieImport(GeoSecure)dv_notificaties_import(ACM/IDM)
De schrijfwijze van de scope is hoofdlettergevoelig.
Uitschrijflink (opt-out)
Wie de contactgegevens en de toestemming voor het versturen van e-mailnotificaties zelf beheert, stuurt voor elke notificatie via de API de e-mailadressen door als onderdeel van de notificatiebundel. Hierbij is de afzender wettelijk verplicht om ook zelf een uitschrijflink of opt-out optie voor gebruikers te voorzien. Diezelfde uitschrijflink moet geconfigureerd worden per afzender. Deze uitschrijflink komt in de footer van de e-mail te staan.