vng-realisatie/notificaties-api

Referentieimplementatie van de notificatierouteringcomponent (NRC).

Notificaties API

Version:	1.0.0
Source:	https://github.com/VNG-Realisatie/notificaties-api
Keywords:	zaken, zaakgericht werken, GEMMA, notificaties

Introductie

De Notificaties API is routeert berichten van componenten (publishers) naar andere componenten (subscribers) volgens het publish-subscribe patroon. Berichten zijn informatie-arm en bevatten daarom geen inhoudelijke informatie.

Elk component kan een kanaal aanmaken waar het berichten op publiseert met door het component gedefinieerde attributen. Op dit kanaal kan een ander component zich abonneren met filters op de attributen.

Het is aan de subscriber om, bij het ontvangen van een bericht, de bron te bevragen naar de informatie waar dan ook de juiste autorisaties voor nodig zijn.

API specificaties

Versie	Release datum	API specificatie	Autorisaties	Notificaties
master	n.v.t.	ReDoc, Swagger (verschillen)	Scopes	Berichtkenmerken
1.0.0	2019-11-18	ReDoc, Swagger	Scopes	Berichtkenmerken

Zie ook: Alle versies en wijzigingen

Ondersteuning

Versie	Release datum	Einddatum ondersteuning	Documentatie
1.x	2019-11-18	(nog niet bekend)	Documentatie

Referentie implementatie

Referentieimplementatie van de Notificaties API. Ook wel Notificatierouteringscomponent (NRC) genoemd.

Ontwikkeld door Maykin Media B.V. in opdracht van VNG Realisatie.

Deze referentieimplementatie toont aan dat de API specificatie voor de Notificaties API implementeerbaar is, en vormt een voorbeeld voor andere implementaties indien ergens twijfel bestaat.

Deze component heeft ook een demo omgeving waar leveranciers tegenaan kunnen testen.

Links

• Deze API is onderdeel van de VNG standaard "API's voor Zaakgericht werken".
• Lees de functionele specificatie bij de API specificatie.
• Bekijk de demo omgeving met de laatst gepubliceerde versie.
• Bekijk de test omgeving met de laatste ontwikkel versie.
• Rapporteer issues bij vragen, fouten of wensen.
• Bekijk de code van de referentie implementatie.

Licentie

Copyright © VNG Realisatie 2018 - 2020

Licensed under the EUPL

notificaties-api's Issues

Implementeren nieuwe NRC specs

Zie README van de nieuwe specificatie. Dit zal uiteindelijk een nieuwe major release met zich meebrengen omdat er over wordt gestapt op Cloud Events en daardoor breaking changes zal bevatten.

Veld omschrijving toevoegen

Het lijkt me handig om bij een notificatie een veld omschrijving beschikbaar te hebben. Dit veld dient als human-readable description. Dit veld kan gebruikt worden in een mailnotificatie of in de applicatie om een gebruiker in eenvoudige en begrijpelijke taal uit te leggen waar de notificatie over gaat.

Ik heb zitten denken of je hiervoor het vel actie kunt gebruiken, maar dat lijkt me niet wenselijk aangezien dit veld een andere functie heeft.

When visualizing the notification log, a success HTTP status code is not marked as such

Given that a notification is delivered to NRC and forwarded to subscribers, there are a couple of options:

• subscriber replies with a 4xx status code -> should be marked as error
• subscriber replies with a 5xx status code -> should be marked as error
• subscriber replies with a 200 status code -> OK, response is discarded
• subscriber replies with a 204 status code -> OK, response is empty
• subscriber replies with a 3xx status code -> unexpected, mark as error

The key takeaway is that any 2xx status code should be reported as OK, which currently isn't the case.

aanmaakDatum hernoemen naar (iets als) datumTijdstipGebeurtenis

Voorstel: aanmaakDatum hernoemen naar (iets als) datumTijdstipGebeurtenis.

Een veldnaam als datumTijdstipGebeurtenis is beschrijvender dan aanmaakDatum. Dit omdat aanmaakdatum in combinatie met een create-gebeurtenis suggereert dat je bij een mutatie of verwijdering een datumVerwijdering of datumMutatie kunt verwachten.

Daarnaast suggereert datum (niet zijnde datumTijdstip) dat je geen tijdstip hoeft te verwachten terwijl dit wel relevant is om de volgordelijkheid van de notificaties te bepalen.

As non-owner of a subscription, I can delete subscriptions of other applications

This is an attack vector - currently anyone can delete any subscriptions.

Perhaps we need to require a secret token that only the owner knows to be provided to be able to delete/alter subscriptions.

Documentatie bijwerken

Bv de README.rst van deze repository beschrijft alleen nog maar de 1.x versie van de Notificaties API.