Document toolboxDocument toolbox

Documentatie voor klanten en partners van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers


Overzicht basisbegrippen Notificaties

Ā 

Meer info en configuratie na aanmelden (met de juiste rol) via:

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.

Type bestemmeling

No-reply mailadres

Type bestemmeling

No-reply mailadres

RijksRegisterNummer

noreply@burgerprofiel.vlaanderen.be

PersoonMetContactInfo

noreply@notificaties.vlaanderen.be

OrganisatieMetContactInfo

noreply@notificaties.vlaanderen.be

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

Om een burger te bereiken met contactvoorkeuren van de afzender

Om een organisatie/ondernemer te bereiken met contactvoorkeuren van de afzender

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

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

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.

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.

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.

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.

ā€‚ā€‚ā€‚ā€‚ā€‚ā€‚ā€‚ā€‚ā€‚ā€‚ā€‚ā€‚

Dit is een officiƫle website van de Vlaamse overheid - Uitgegeven door Digitaal Vlaanderen: https://www.vlaanderen.be/digitaal-vlaanderen

DISCLAIMER: http://www.vlaanderen.be/nl/disclaimer
TOEGANKELIJKHEID: http://www.vlaanderen.be/nl/toegankelijkheid