| Table of Contents |
|---|
...
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.
...
Afzenders mailnotificaties
Mailnotificaties zijn “actieve notificaties”. Deze e-mails worden verstuurd vanuit no-reply-mailadressen, afhankelijk van het type bestemmeling.
...
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 (de afzender en/of aanbieder) 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.
Bestemmeling
De bestemmeling is de ontvanger van de notificaties.
Bestemmelingtypes
Om een burger te bereiken met contactvoorkeuren van Mijn Burgerprofiel
...
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"Codes") voor:
Vrije notificatie
...
:
"Code":
...
"VrijeNotificatie"Vervaldagbericht:
"Code": "VervaldagBericht"
Endpoints
Base lines:
TNI:
https://notificaties.api.tni-vlaanderen.be/PROD:
https://notificaties.api.vlaanderen.be/
...
| Info |
|---|
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 Het kanaal is de manier waarop de bestemmeling wordt bereikt. Notificaties beschikbaar maken kan via meerdere deze kanalen:
Passieve notificaties, getoond in de global header van de site en in de Brievenbus van Mijn Burgerprofiel
Actieve of E-mailnotificaties naar de bestemmeling van de notificatie
...
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 carolien.willen christophe.vanderhaeghen checken Een alias, bijv. : afzender, officiële naam = Stad Kortrijk, | ||
Vervaldatum | Alleen voor passieve notificaties - die worden na de vervaldatum niet meer getoond in Mijn Burgerprofiel.
| ||
Verzenddatum | Om de notificatie niet meteen te versturen naar de bestemmeling - de notificatie wordt pas verzonden op deze datum.
|
...
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.