Overzicht basisbegrippen Notificaties

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.

Afzenders mailnotificaties

Mailnotificaties zijn “actieve notificaties”. Deze e-mails worden verstuurd vanuit no-reply-mailadressen, afhankelijk van het type bestemmeling.

Agent

Agent is de verzamelnaam van alle types bestemmelingen: burgers, ondernemingen, verenigingen, lokale besturen, …

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

• 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

Categorieën

Templates om de vormgeving van de notificaties consistent te houden. Zo bestaan er bijv. templates ("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/

De endpoints om de notificatiebundel te versturen:

• TNI: https://notificaties.api.tni-vlaanderen.be/api/v2/notificaties 

• PROD: https://notificaties.api.vlaanderen.be/api/v2/notificaties

In de Swagger-documentatie zijn de API-endpoints opgesplitst op basis van actor: afzender of agent

Kanalen

Het kanaal is de manier waarop de bestemmeling wordt bereikt. Notificaties beschikbaar maken kan via 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

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.

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.

OVO-code

OVO staat voor “Organisatie Vlaamse Overheid”. Elke organisatie-éénheid of suborganisatie binnen de Vlaamse overheid beschikt over zo'n OVO-code die verwijst naar het organisatieregister.

Scope

De scope waaraan het access token toegang zal geven. Voor de Notificaties-API is de scope: dv_notificaties_import (ACM/IDM)

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.