Zaakgericht werken

API standaarden zaakgericht werken

De API-standaarden voor zaakgericht werken zijn de opvolger van de Zaak- en Documentservices (ZDS) en helpen bij het (ont)koppelen van zaaksystemen en de registers waar documenten en overige informatie in zijn opgeslagen.

Doel van dit product

De API-standaarden voor zaakgericht werken stellen gemeenten in staat om de informatievoorziening rondom zaakgericht werken in te richten volgens de informatiekundige visie Common Ground. Hiermee zetten ze een eerste stap in de richting van een modernisering van het ICT-landschap.

Waarom

Voor leveranciers van gemeentelijke softwarepakketten bieden de nieuwe API-standaarden de basis voor het gebruiken en ontsluiten van zaakgegevens conform deze informatiekundige visie. De standaarden zorgen ook dat leveranciers dit allemaal op dezelfde manier doen en zaakgegevens ook tussen (systemen van) verschillende leveranciers uitgewisseld kunnen worden.

De API-standaarden voor zaakgericht werken dragen als eerste standaard bij aan het realiseren van de informatiekundige visie Common Ground, waarin applicaties en gegevens van elkaar gescheiden zijn. In het “Gegevenslandschap” dat hierdoor ontstaat kunnen gegevens via API’s (Application Programming Interfaces) rechtstreeks bij de bron bevraagd en gewijzigd worden. Data worden dus niet langer gekopieerd en op meerdere plekken opgeslagen, wat garandeert dat gemeenten altijd met de juiste, actuele gegevens werken.

Nieuwe vorm van standaardisatie

Bij de ontwikkeling van de API-standaarden wordt gebruikgemaakt van een nieuwe vorm van standaardisatie, zowel qua vorm als proces. De standaarden worden ontwikkeld als RESTful API’s, die aansluiten bij de landelijke API-strategie. Deze aanpak vervangt uiteindelijk de StUF-berichtenstandaard.

Voor het ontwikkelproces proces is een agile aanpak gekozen, waarbij de standaard iteratief wordt ontwikkeld en verbeterd, op basis van reële wensen, user stories, uit de praktijk. Hebt u wensen of feedback op de standaard dan kunt u terecht op Github, of contact met ons opnemen via standaarden.ondersteuning@vng.nl

Waaruit bestaan de API-standaarden voor Zaakgericht Werken?

In lijn met de informatiekundige visie Common Ground en de architectuur van het GEMMA Gegevenslandschap, worden gegevens over zaken en aanverwante gegevens als documenten, besluiten, klantcontacten, los van processystemen, opgeslagen in specifieke registraties. Deze gegevens kunnen worden bevraagd, en bijgewerkt via API’s.

API landschap

De API-standaarden zijn ontwikkeld in de context van zaakgericht werken. Een deel van de API-standaarden zal ook buiten Zaakgericht Werken toepassingen krijgen. Immers, niet alle documenten of besluiten in een gemeente hoeven bij een zaak te horen. Denk bijvoorbeeld aan raadsbesluiten.

Voor iedere API is er een OAS 3-specificatie, een referentie-implementatie en aanvullende documentatie beschikbaar. De OAS 3-specificaties met beschrijvingen zijn normatief. De referentie-implementatie en overige documentatie is ondersteunend en ter informatie.  De specificaties, documentatie en links naar de referentie-implementaties zijn te vinden op Github.