Wat is een API-standaard?

Een Application Programming Interface (API) is een manier om twee of meer computerprogramma’s met elkaar te laten communiceren. Het is een soort software-interface die een dienst aanbiedt aan andere stukjes software.

De API’s werken volgens de REST-architectuurstijl en volgen de REST-API Design Rules standaard.

Welke API-standaarden

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.

Voor een overzicht van de voor gemeenten relevante API-standaarden, ga naar de GEMMA standaardenlijst (API-standaarden).

Compliancy

De API-testvoorziening ondersteunt ontwikkelaars bij het controleren en valideren van API’s. Door het uitvoeren van tests kunnen potentiële problemen vroegtijdig worden geïdentificeerd en opgelost. De API-testvoorziening wordt vervolgens gebruikt om aan te tonen dat de gerealiseerde API compliant is met de API-standaard.