API-standaarden

Laatst bewerkt: 10 mei 2021, 17:06:07

VNG Realisatie beheert een groot deel van de gemeentelijke standaarden voor gegevens- en berichtenverkeer. Ontwikkelingen, als het digitaliseren van zaakgerichte processen, de Omgevingswet, het sociaal domein en het vernieuwen van de ontsluiting van basisregistraties maken het vernieuwen van standaarden noodzakelijk. Sinds 2019 werken gemeenten, ketenpartners, VNG en marktpartijen aan het realiseren van API-standaarden.

De Community API-standaarden is in oprichting en werkt aan een nieuw raamwerk standaardisatie gegevensuitwisseling. Dit raamwerk beschrijft hoe we samen zo lean mogelijk het proces van standaardisatie organiseren terwijl ondertussen werkgroepen doorontwikkelen binnen de kaders. Hierbij alvast een voorbeeld van een raamwerk dat vormgegeven zal worden

Raamwerk standaardisatie v2.jpg
Over deze afbeelding

Status van API-standaarden voor gemeenten

Er zijn inmiddels al standaard API-specificaties op de pas toe leg uit lijst geplaatst. Het complete overzicht van alle API-standaarden is te vinden op de API-ontwikkelagenda. Hieronder staat de fasering van API's uitgelegd en onderaan deze pagina vind je de status van de formeel goedgekeurde API-standaarden..

Idee

Zeer prille fase, idee wordt ergens gevormd in gemeente of keten. Idee kan ook als een onderwerp top down wordt ingebracht, bijvoorbeeld wetgeving. Geen/amper capaciteit aan besteed, nog geen inschatting van kosten en capaciteit.

Analyse

Initiatiefnemers doen onderzoek naar wat het in houdt en om goedkeuring te krijgen. Verschillende oplossingsrichtingen worden uitgewerkt en een architectuurtoets wordt uitgevoerd. Er wordt een inschatting (eventueel met eerste impactanalyse) gemaakt. Als product van deze fase een verkorte zakelijke rechtvaardiging. Het item heeft een eerste inschatting van kosten en capaciteit.

Realisatie

De initiatieven op de backlog worden in uitvoering genomen. De standaard wordt ontworpen, óf een in ontwikkeling zijnde API wordt tot standaard geadopteerd, conform het adoptieproces. Eerste stap is een architectuurconcept en informatiemodel. API-standaarden met de status ‘realisatie' kunnen gebruikt worden door gemeenten en leveranciers, maar toepassing in productiesystemen wordt niet aanbevolen. Veranderingen in specificaties die ervoor zorgen dat voorgaande versies of afhankelijke componenten niet langer werken ('breaking changes') kunnen onbeperkt en onaangekondigd worden doorgevoerd.

Release Kandidaat

De realisatiefase eindigt met het uitbrengen van een release kandidaat - een versie van de API die de voorgenomen productiespecificaties omvat waarop belanghebbende gedurende een bepaalde periode kunnen reageren

Implementeerbaar

Als een API-standaard de vorige fase succesvol heeft doorlopen, wordt een productieversie uitgebracht. Een API met een versienummer van 1.0 of hoger krijgt de status ‘implementeerbaar', en is geschikt voor gebruik in productiesystemen. API-standaarden met de status ‘implementeerbaar' kunnen door gemeenten en leveranciers in productiesystemen worden geïmplementeerd. De in de Gemeentelijke ICT-kwaliteitsnormen bij de GIBIT benoemde verplichting tot implementatie van API-standaarden geldt vanaf het moment dat een API-standaard de status ‘Implementeerbaar' heeft bereikt. Veranderingen in specificaties die ervoor zorgen dat voorgaande versies of afhankelijke componenten niet langer werken ('breaking changes') kunnen maximaal twee keer per jaar gedurende vastgestelde releasemomenten worden doorgevoerd. Deze resulteren altijd in een nieuwe 'major release'. VNG Realisatie ondersteunt voor iedere API-standaard de meest recent uitgebrachte major release en (voor zover van toepassing) de voorafgaand uitgebrachte major release. Minor releases, die geen breaking changes omvatten kunnen onbeperkt en op ieder moment worden uitgebracht. Meer details over het releasebeleid is te vinden op GitHub-pagina over versiebeheer en releasemangement. De hier beschreven uitgangspunten gelden alleen voor API-standaarden die door VNG Realisatie worden beheerd.

Verbindend verklaard

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. Een API-standaard met de status realisatie' zal op een gegevens moment vrijwel altijd de status ‘implementeerbaar' bereiken. Deze statussen zijn opeenvolgend. Voor een verbindendverklaring geldt iets anders: die is aanvullend is bij de status ‘implementeerbaar'. Een verbindendverklaring bepaalt alléén de mate waarin gemeenten verplicht zijn een (API-)standaard toe te passen, en beïnvloedt dus niet de geschiktheid van die API-standaard voor gebruik in productiesystemen of het releasebeleid van de standaard.  

Welke standaarden zijn in gebruik?

API-standaard In beheer bij In ontwikkeling - 1.0-versie verwacht in In gebruik (versie ≥ 1.0 ) vanaf datum Mate van verbindendheid
Onderdeel van API-standaarden voor Zaakgericht Werken
Zaken API VNG Realisatie 27-11-2019 pas toe leg uit
Catalogi API VNG Realisatie 27-11-2019 pas toe leg uit
Documenten API VNG Realisatie 27-11-2019 pas toe leg uit
Besluiten API VNG Realisatie 27-11-2019 pas toe leg uit
Autorisaties API VNG Realisatie 27-11-2019 pas toe leg uit
Notificaties API VNG Realisatie 27-11-2019 pas toe leg uit
Onderdeel van Haal Centraal
BAG Bevragen API 13-8-2020 nader te bepalen
BRK Bevragen API 3-6-2020 nader te bepalen
BRP Bevragen API 01-10-2020 nader te bepalen

Hoe komen we samen tot API-standaarden?

Voorheen werd er toegewerkt naar één openbare consultatie waarmee een standaard eenmalig werd getoetst bij stakeholders. Bij de nieuwe werkwijze is er sprake van een voortdurende afstemming met partijen waarbij meerdere instrumenten worden ingezet, te weten:

  • Repositories op Github: te allen tijde kunnen partijen de stand van zaken raadplegen en de planning raadplegen. Ook kunnen zij bugs inschieten en wensen aanmelden in de vorm van user stories.
  • Referentiecomponenten en API testvoorziening in de cloud waartegen getest kan worden.
  • Presentaties op de Leveranciersdag van VNG-Realisatie.
  • Fieldlabs waar in sessies de toekomstige behoeften in kaart gebracht worden.

Deze instrumenten tezamen zijn onderdeel van de openbare consultatie. Er zal dus sprake zijn van een voortdurende consultatie van de stakeholders, waarmee ook de kans ontstaat om de standaard voortdurend te verbeteren op aangeven van de gebruikers.

‘Issues’ en ‘Pull Requests’ zijn dus meer dan welkom.

Problemen, suggesties en vragen

Het is niet nodig om software of documentatie te schrijven om toch bij te dragen. De ontwikkeling is ook gebaat bij gerapporteerde problemen, suggesties voor wijzigingen en vragen over dingen die (nog) onduidelijk zijn. Om dit te doen kan een issue worden gemaakt. Op de supportpagina’s van GitHub staat uitleg over het maken van issues.

Status vernieuwde informatiemodellen

De informatiemodellen RSGB3, RGBZ2 en ImZTC2.02 zijn goedgekeurd. Toch hebben de nieuwe versies van deze standaarden de status ‘in ontwikkeling’. Zij krijgen de status ‘in gebruik’ nadat ze zijn geïmplementeerd in één of meer standaarden.

Wat betekent de ontwikkeling van API-standaarden voor de bestaande StUF-standaarden?

De ontwikkeling van StUF 03.02 en de daarmee samenhangende sectormodellen StUF BG 03.20 en StUF ZKN 03.20 is stopgezet. VNG Realisatie blijft support leveren bij de huidige generatie StUF-standaarden. Dat betekent dat we bugs, fouten en problemen herstellen. In 2021 werken we aan de transitieplan om tot uitfasering van StUF te komen.