Intakeadvies uitbreiding Digikoppeling met REST API koppelvlak

Vergadering: Forum Standaardisatie 9 juni 2021

Agendapunt: 3C

Documentnummer: FS-20210609.3C

Aan: Forum Standaardisatie

Van: Stuurgroep Open Standaarden

Datum: 27 mei 2021

Versie: 2.2

Bijlagen: geen

1. Advies

Het Forum Standaardisatie wordt geadviseerd om Digikoppeling in procedure te nemen voor de toevoeging van een nieuw REST API koppelvlak bij de standaard en aangepaste verwoording van het functioneel toepassingsgebied. Het gaat hierbij nadrukkelijk om een verduidelijking en niet om een wijziging van het functioneel toepassingsgebied.

2. Over de standaard

Digikoppeling bestaat uit een set koppelvlakstandaarden voor gestructureerd berichtenverkeer met en tussen overheidsorganisaties. De standaarden bevatten afspraken om berichten juist te adresseren, leesbaar en uitwisselbaar te maken en veilig en betrouwbaar te verzenden.

Digikoppeling bestaat uit drie koppelvlakken:

1. WUS: voor bevragingen met direct antwoord
2. ebMS: voor zowel bevragingen met direct antwoord als meldingen / transacties met uitgesteld antwoord
3. Grote Berichten: voor uitwisselen van grote

Aan Digikoppeling is recentelijk een REST API Koppelvlak toegevoegd. Waar de ebMS en WUS koppelvlakken SOAP principes gebruiken, maakt het nieuwe API koppelvlak gebruik van REST principes. Het REST API koppelvlak van Digikoppeling is conform de standaard REST API DesignRules die op de ‘pas-toe-of-leg-uit’ lijst staat. Tevens laat het REST API koppelvlak implementatie met de NLX van Common Ground toe.

3. Betrokkenen en proces

Op 12 april 2021 heeft Logius de uitbreiding van Digikoppeling met het REST API koppelvlak aangemeld, en stelde daarbij ook een verduidelijking van het functioneel toepassingsgebied voor. Op 20 april 2021 heeft een intakegesprek plaatsgevonden met de indiener, procedurebegeleider Lost Lemon en Bureau Forum Standaardisatie.

In dit gesprek is onderzocht of de toevoeging van het REST API koppelvlak en de verduidelijking van het functioneel toepassingsgebied voldoen aan de criteria om in procedure genomen te worden. Daarnaast is vooruitgeblikt op de procedure. Dit intakeadvies is tot stand gekomen op basis van het intakeonderzoek.

4. Wat is de reden van de voorgestelde wijzigingen?

In deze paragraaf worden de voorgestelde wijzigingen van Digikoppeling op de ‘pas-toe-of-leg-uit’ lijst toegelicht. Paragraaf 3.1 bespreekt de meerwaarde en impact van de toevoeging van het REST API koppelvlak, en paragrafen 3.2-3.5 beantwoorden vragen over de verduidelijking van het functioneel toepassingsgebied.

4.1. Wat is de meerwaarde en impact van de toevoeging van het REST API Koppelvlak?

Logius krijgt van gebruikers regelmatig vragen of REST APIs mogen worden toegepast in plaats van of in aanvulling op Digikoppeling. Door een REST API Koppelvlak aan Digikoppeling toe te voegen, wordt het mogelijk om REST APIs in te zetten en tegelijkertijd te voldoen aan de ‘pas-toe-of-leg-uit’ verplichting van Digikoppeling. Digikoppeling en REST APIs sluiten elkaar dus niet meer uit.

Wel moet de inzet van het REST API koppelvlak bij Digikoppeling aan een aantal afspraken voldoen, met name conformiteit aan de REST API Design Rules die op de ‘pas-toe-of-leg- uit’ lijst staan. Het is dus niet zo dat een willekeurige REST API zomaar kan worden ingezet als onderdeel van Digikoppeling.

Digikoppeling blijft met het toegevoegde REST API koppelvlak alle bestaande koppelvlakken (WUS, ebMS en Grote Berichten) ondersteunen. De uitbreiding van Digikoppeling met een REST API koppelvlak heeft dus geen impact op de bestaande toepassingen van Digikoppeling.

4.2. Waarom moet het functioneel toepassingsgebied worden aangepast?

Het huidige functioneel toepassingsgebied is als volgt geformuleerd:

"Digikoppeling moet worden toegepast op alle digitale gegevensuitwisseling met behulp van gestructureerde berichten die plaatsvindt met voorzieningen die onderdeel zijn van de GDI, waaronder de basisregistraties, of die sector-overstijgend is. Geautomatiseerde gegevensuitwisseling tussen informatiesystemen op basis van NEN3610 is uitgesloten van het functioneel toepassingsgebied."

Het huidige functioneel toepassingsgebied laat te veel ruimte voor verschillende interpretaties. Met name geeft de tekst onvoldoende duidelijkheid dat Digikoppeling alleen verplicht is voor gegevensuitwisseling waarbij de afnemer van de gegevens moet worden geauthenticeerd. Met een aanpassing van de verwoording beoogt Logius het functioneel toepassingsgebied te verhelderen.

De toevoeging van een nieuw REST API koppelvlak is nadrukkelijk niet de aanleiding voor de aanpassing van de bewoording van het functioneel toepassingsgebied. Het gaat strikt om een verduidelijking, en niet om een wijziging van het functioneel toepassingsgebied.

4.3. Wat is onduidelijk aan het huidige toepassingsgebied van de standaard?

Het huidige functioneel toepassingsgebied beschrijft niet expliciet dat Digikoppeling alleen verplicht is voor gegevensuitwisseling waarbij tweezijdige authenticatie moet plaatsvinden. En dus bijvoorbeeld niet op websites of webapplicaties. De voorgestelde wijziging moet dit verhelderen (zie paragraaf 3.5).

4.4. Is het organisatorisch werkingsgebied nog passend?

Het organisatorisch werkingsgebied is nog steeds actueel en accuraat. Dit kan dus gehandhaafd worden.

4.5. Voorstel voor een aangepaste beschrijving van het functioneel toepassingsgebied

De voorgestelde wijziging van functioneel toepassingsgebied is als volgt geformuleerd:

"Digikoppeling moet worden toegepast bij digitale gegevensuitwisseling die plaatsvindt met voorzieningen die onderdeel zijn van de GDI, waaronder de basisregistraties, of die sector-overstijgend is. De verplichting geldt voor gegevensuitwisseling waarbij er noodzaak is voor de aanbieder van gegevens om de afnemer van gegevens te authentiseren. Geautomatiseerde gegevensuitwisseling tussen informatiesystemen op basis van NEN3610 is uitgesloten van het functioneel toepassingsgebied."

Ten opzichte van het oorspronkelijke functioneel toepassingsgebied is alleen de tweede zin toegevoegd. Deze zin verduidelijkt de reikwijdte van de verplichting en sluit aan bij de toelichting die al over de verplichting van Digikoppeling op de website van het Forum Standaardisatie stond (zie ‘Overig’ – ‘Waarvoor geldt de verplichting’ op de webpagina van Digikoppeling.

5. Is er zicht op een positief expertadvies?

Wanneer het Forum Standaardisatie het gewijzigde voorstel voor het functioneel toepassingsgebied in procedure neemt, zal een groep experts de standaard gaan toetsen op de vier inhoudelijke criteria voor opname op de lijst.

Het Forum Standaardisatie neemt geen standaarden in procedure waarvan al vaststaat dat deze in het expertonderzoek op tenminste één van de criteria zal stranden. Daarom wordt in dit intakeadvies vooruitgeblikt op de vier inhoudelijke criteria.

Het intakeonderzoek heeft geen inhoudelijke criteria gevonden die een positief expertadvies voor aanpassing van het functioneel toepassingsgebied of toepassing van een nieuwe koppelvlak van Digikoppeling op de ‘pas toe of leg uit’-lijst in de weg zou kunnen staan.

Dit wordt hieronder toegelicht in paragrafen 5.1 tot 5.4.

5.1. Toegevoegde waarde

Gegeven het wereldwijde gebruik van REST-gebaseerde API’s en de vraag van gebruikers om Digikoppeling ook van een REST API koppelvlak te voorzien, heeft de uitbreiding van Digikoppeling met het REST API Koppelvlak belangrijke toegevoegde waarde. Bovendien worden met de toevoeging van het nieuwe koppelvlak de standaarden REST API Design Rules en Digkoppeling in samenhang met elkaar aangeboden.

De aanpassing van het functioneel toepassingsgebied beoogt verduidelijking van het functioneel toepassingsgebied. Ook dit heeft toegevoegde waarde voor gebruikers.

De kosten van implementatie van Digikoppeling wijzigen niet en kunnen voor sommige toepassingen zelfs dalen door de toevoeging van een REST API koppelvlak. Ook de beveiligings- en privacyrisico’s worden niet groter door het toevoegen van een REST API koppelvlak.

5.2. Open standaardisatieproces

Logius heeft het predicaat ‘uitstekend beheer’ voor Digikoppeling. In 2013 en 2018 is beheer van Digikoppeling nogmaals getoetst en voldeed het ruimschoots aan het criterium ‘open beheerproces’. Wel dient de website van Digikoppeling aangepast te worden zodat deze is bijgewerkt met informatie over het nieuwe koppelvlak voor REST API’s.

5.3. Draagvlak

Het Forum Standaardisatie deed in 2018 een oproep om de ontwikkelingen rondom de standaarden met betrekking tot het gebruik van (REST) API’s te monitoren om de ontwikkeling van Digikoppeling hierop aan te laten sluiten. In de afgelopen 10 jaar zijn REST APIs een gangbare technologie geworden die SOAP gebaseerde APIs in veeltoepassingen heeft verdrongen.

Met het aanbieden van een REST API koppelvlak komt Digikoppeling tegemoet aan de vraag van veel Digikoppeling gebruikers en ondersteunt Digikoppeling inmiddels gangbare technologie.

Zowel overheidsorganisaties als marktpartijen ondersteunen de uitbreiding van Digikoppeling met een REST API koppelvlak. Deze organisaties zijn vertegenwoordigd in de Digikoppeling community. In afstemming met de aansluitcoördinator van Logius is het mogelijk om de conformiteit van een implementatie aan Digikoppeling te toetsen, dit geldt ook voor het nieuwe koppelvlak.

Voor wat betreft de aanpassing van het functioneel toepassingsgebied wordt het draagvlak getoetst bij de te betrekken experts. Aangezien het een verduidelijking betreft lijkt er voldoende draagvlak aanwezig.

5.4. Opname op de lijst bevordert adoptie

De huidige status van de standaard is ‘verplicht’. Dit is nog altijd een passend middel om het gebruik van Digikoppeling te stimuleren. De toevoeging van een REST API koppelvlak maakt het voor gebruikers gemakkelijker om Digikoppeling toe te passen waar dat verplicht is. Dit zou de adoptie van Digikoppeling verder moeten aanjagen.

6. Samenhang met andere standaarden op de lijst

Het nieuwe REST API koppelvlak van Digikoppeling verwijst naar de REST API Design Rules die op de ‘pas-toe-of-leg-uit’ lijst staan. Het REST API koppelvlak kan gezien worden als een profiel op de REST API Design Rules dat in het domein van Digikoppeling toegepast moet worden. De standaarden vullen elkaar op deze manier aan.

7. Welke organisaties ondersteunen deze aanmelding?

De voorliggende uitbreiding van de Digikoppeling standaard komt voort uit en wordt ondersteund door de Digikoppeling community. Deze community bestaat uit tenminste 18 overheidsorganisaties en –koepels en verschillende marktpartijen.

8. Use case

Digikoppeling bestaat nu uit drie koppelvlakstandaarden. Hieraan wordt een REST API koppelvlak toegevoegd. Om een keuze te maken tussen de koppelvlakken die Digikoppeling biedt, heeft Logius een aantal afwegingen op een rij gezet. Hierbij wordt geïnventariseerd wat de aard is van de uit te wisselen gegevens of bestanden en de context waarin deze keuze gemaakt wordt.

Het Digikoppeling REST API koppelvlak kan bijvoorbeeld worden toegepast bij het raadplegen of muteren van een gegevensbron. Een bevragende applicatie (client) kan zich ‘abonneren’ op wijzigingen in een gegevensbron van een aanbieder (server). De aanbieder informeert een abonnee (client) bij een wijziging. De abonnee haalt deze dan vervolgens op bij de aanbieder. In de praktijk past KOOP dit model al toe bij het aanmaken, bewerken of verwijderen van een publicatie op de Staatscourant.

En VNG werkt aan decentrale notificatieservices met behulp van het Digikoppeling REST API koppelvlak.