API Standaarden

Het wordt steeds belangrijker voor (applicatie)componenten om onderling goed samen te werken. Om dit mogelijk te maken kennen componenten (applicatie)services die voor andere componenten toegankelijk zijn via zogenaamde ‘Application Programming Interfaces’ (API’s). Zo kunnen componenten op een gestructureerde manier functionaliteit van andere componenten gebruiken. Bijvoorbeeld door een API aan te bieden die voor andere componenten bruikbaar is om gegevens uit een achterliggende bronregistratie te gebruiken.

Om doelmatig en efficiënt met API’s te werken is het belangrijk om de manier waarop API’s worden ontwikkeld, gedocumenteerd, getest en werken te standaardiseren. Er zijn een aantal manieren om dit te realiseren. Een daarvan is het kiezen voor een bepaalde architectuurstijl. Net als in de rest van de wereld geldt ook voor de Nederlandse overheid dat de voorkeur momenteel uitgaat naar API’s die werken volgens de REST-architectuurstijl . Maar dan nog geldt dat er aanvullende ontwerpkeuzes moeten worden gemaakt. Daarom is afgesproken om overheidsbrede afspraken te maken over hoe de REST-stijl wordt toegepast bij het ontwerpen van API’s. Deze afspraken zijn vastgelegd in de REST-API Design Rules standaard.

Op de website developer.overheid.nl is te zien dat er steeds meer overheids-API’s beschikbaar komen die allerlei soorten functionaliteit aanbieden. Op data.overheid.nl worden (ook) API-specificaties gepubliceerd waarmee open data is op te vragen. Voor gemeenten zijn met name API’s interessant waarmee elders vastgelegde brongegevens toegankelijk worden gemaakt. Gebruik daarvan kan bijvoorbeeld leiden tot hogere actualiteit en betrouwbaarheid van data en het onderhouden van lokale kopieën overbodig maken.

De GEMMA Architectuurvisie beschrijft hoe standaardisatie via het gebruik van API’s cruciaal is om toe te kunnen werken naar een fundamenteel betere informatievoorziening voor gemeenten. Iets dat verder wordt uitgewerkt binnen de thema-architectuur Common Ground die de architectuur uitwerkt die nodig is om de doelen van Common Ground te realiseren.

Vanuit de VNG wordt op verschillende manieren gewerkt aan de ontwikkeling van gestandaardiseerde API’s:

  • Via het programma HaalCentraal is gewerkt aan het ontwikkelen van de HaalCentraal API’s zodat gemeenten beter data kunnen opvragen uit de basisregistraties.
  • Het project Notificatieservices heeft een concept-standaard ontwikkeld voor het notificeren van plaatsgevonden gebeurtenissen, zoals het wijzigen van brongegevens, aan daarop geabonneerde afnemers. Deze NL GOV for CloudEvents standaard is nu in beheer bij Logius.
  • Voor ondersteuning van zaakgericht werken binnen gemeenten zijn API-standaarden voor zaakgericht werken ontwikkeld.

Overzicht vastgestelde API standaarden

Het overzicht hieronder toont de door het College van Dienstverleningszaken door het VNG-bestuur of de Algemene Ledenvergadering van de VNG vastgestelde API-standaarden.

Standaard Beheerder Status Datum Onderdeel van
Zaken API VNG Realisatie Pas-toe-of-leg-uit 27-11-2019 Domein Dienstverlening (Zaakgericht werken)
Documenten API VNG Realisatie Pas-toe-of-leg-uit 27-11-2019 Domein Dienstverlening (Zaakgericht werken)
Besluiten API VNG Realisatie Pas-toe-of-leg-uit 27-11-2019 Domein Dienstverlening (Zaakgericht werken)
Autorisaties API VNG Realisatie Pas-toe-of-leg-uit 27-11-2019 Domein Dienstverlening (Zaakgericht werken)
Notificaties API VNG Realisatie Pas-toe-of-leg-uit 27-11-2019 Domein Dienstverlening (Zaakgericht werken)
Objecten API OpenZaak Community Pas-toe-of-leg-uit 13-01-2021 Domein Dienstverlening (Zaakgericht werken)
Objecttypen API OpenZaak Community Pas-toe-of-leg-uit 13-01-2021 Domein Dienstverlening (Zaakgericht werken)
BAG Bevragen API Kadaster Pas-toe-of-leg-uit 13-08-2020 Haal Centraal
BRK Bevragen API Kadaster Pas-toe-of-leg-uit 03-06-2020 Haal Centraal
BRP Bevragen API RvIG Pas-toe-of-leg-uit 01-10-2020 Haal Centraal
WOZ Bevragen API Waarderingskamer Pas-toe-of-leg-uit 16-12-2021 Haal Centraal
Regels bij activiteiten API VNG Realisatie Pas-toe-of-leg-uit 01-07-2021 Fysiek domein

Vaststelling statussen van standaarden (VNG)

Een verbindend verklaarde API-standaard is na een advies van het College van Dienstverleningszaken door het VNG-bestuur of de Algemene Ledenvergadering van de VNG als standaard vastgesteld. Een vaststelling kan verschillende gradaties van verbindendheid tot gevolg hebben: van ‘aanbevolen deze standaard te gebruiken’ tot ‘verplicht deze standaard toe te passen’. In de tabel wordt per vastgestelde API-standaard aangegeven welke mate van verbindendheid geldt. Het proces van standaardverklaring is vastgesteld door het College van Dienstverleningszaken op 12 oktober 2018.

Standaarden kunnen volgens drie niveaus van verbindendheid worden vastgesteld:

  1. Advies (‘Aanbevolen’)
    • Mate van verbindendheid: vrijblijvend en geen formele status.
    • Proces vaststelling: vaststellen door directie VNG
    • Voorbeeld: klantreizen, modelverordeningen
  2. Standaardverklaring (‘Pas toe of leg uit’)
    • Mate van verbindendheid: niet vrijblijvend, ‘pas toe of leg uit’-principe naar voorbeeld Forum Standaardisatie.
    • Proces vaststelling: tenminste op advies van het College van Dienstverleningszaken door bestuur VNG, ledenraadpleging facultatief, monitoring toepassing door VNG (bijvoorbeeld via Waarstaatjegemeente.nl) en lokaal via reguliere P&C cyclus door gemeenteraad.
    • Voorbeeld: GIBIT
  3. Verbindend verklaren (‘Verplicht’)