Magazijn

Zaakgericht werken API

Project

De API’s voor Zaakgericht werken ontsluiten zaakgegevens. Zo worden ze beschikbaar voor alle relevante gemeentelijke ICT-systemen. Gemeenten hoeven gegevens niet meer te kopiëren of over te nemen uit andere bronnen, maar halen ze rechtstreeks op bij de bron. Dat zorgt voor een betere kwaliteit van gegevens, die altijd actueel zijn.

Doel van dit project

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 de modernisering van het ICT-landschap. 

Beschrijving

De API-standaarden voor Zaakgericht werken zijn ontwikkeld voor en door gemeenten binnen de informatiekundige visie van Common Ground, waarin applicaties en gegevens van elkaar gescheiden zijn. Gegevens over zaken en aanverwante gegevens (zoals documenten, besluiten en zaaktypen) worden los van processystemen opgeslagen in specifieke registers. Deze gegevens kunnen via API’s rechtstreeks bij de bron bevraagd en gewijzigd worden. Dit betekent dat data niet langer gekopieerd en op meerdere plekken in gemeentelijke systemen opgeslagen worden. Gemeenten werken daardoor altijd met actuele en juiste gegevens en hebben meer regie over hun eigen informatiehuishouding.

Ook voor leveranciers

De API-standaarden Zaakgericht werken gelden ook voor leveranciers van gemeentelijke softwarepakketten die zaakgegevens gebruiken en ontsluiten. Wanneer software gebruik maakt van dezelfde API’s, wordt het mogelijk dezelfde zaakgegevens te gebruiken in systemen van verschillende leveranciers. Het College van Dienstverleningszaken heeft geadviseerd de standaard vanaf 2022 verplicht te maken. Het toepassen van de API-standaarden hoeft echter niet in één klap op het hele applicatielandschap te gebeuren, maar kan per proces worden uitgevoerd. Dit is volgens het Common Ground-principe ‘oud naast nieuw’. 

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 opgeslagen in specifieke registers, los van processystemen. Dit is ook zo voor aanverwante gegevens als documenten, besluiten, zaaktype catalogus etc. Al deze gegevens kunnen worden bevraagd en bijgewerkt via API’s.

De API’s voor Zaakgericht werken zijn ontwikkeld als RESTful API’s, die aansluiten bij de landelijke API-strategie. API’s zullen uiteindelijk de StUF-berichtenstandaard vervangen. 

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 zijn ondersteunend en ter informatie. De specificaties, documentatie en links naar de referentie-implementaties zijn te vinden op Github.

Praktijkvoorbeeld

In 2021 heeft gemeente Sudwest Fryslan een succesvolle overstap gemaakt en hun zaaksysteem wat inmiddels end-of-life was vervangen door een implementatie van de API’s voor Zaakgericht werken. Hiermee zijn de zaakgegevens toekomstbestendig opgeslagen in moderne registers die aansluiten bij het Gegevenslandschap. Om de bestaande taakapplicaties aan te sluiten die nog op basis van StUF ZKN en Zaak- Documentservices werken heeft Sudwest Fryslan de Open Zaakbrug ontwikkeld. Meer over deze open source tool is te vinden op de github website

Aan de slag met API-standaarden

De serie ‘Aan de slag met API-standaarden voor Zaakgericht Werken’ bestaat uit drie op elkaar aansluitende delen: 

1. Vergelijking tussen API-standaarden voor Zaakgericht Werken en Zaak- en Documentservices 
Hierin worden de fundamentele verschillen tussen het werken met StUF- en API-standaarden besproken. Het document concretiseert verder welke voordelen  implementatie van de API-standaarden met zich meebrengt voor stakeholders bij zowel gemeenten en leveranciers. 

2. API-standaarden voor Zaakgericht Werken gerelateerd aan GEMMA 2-referentiecomponenten 
Dit document koppelt de verschillende API-standaarden voor Zaakgericht Werken aan GEMMA 2-referentiecomponenten die een rol hebben binnen het zaakgericht werken. Omdat per referentiecomponent beschreven wordt welke API-standaarden relevant zijn, kan dit document bij verwervingstrajecten worden ingezet om te bepalen welke eisen en wensen aan (potentiële) leveranciers kunnen worden gesteld. 

3. Eisen en Wensen voor oplossingen voor zaakgericht werken 
Deze handreiking dient als inspiratiebron voor gemeenten die bezig zijn met (voorbereiding van) een verwervingstraject voor een oplossing voor zaakgericht werken. Door de gewenste oplossing te koppelen aan één of meerdere referentiecomponenten uit het document hierboven kunnen eisen en wensen verder worden afgestemd op een specifieke opdracht. Naast deze handreiking bevat ook de GIBIT waardevolle ondersteuning bij het uitvragen van API standaarden.

Meer weten?

Er zijn twee gebruikersgroepen voor de API’s voor Zaakgericht werken. De functionele gebruikersgroep bestaat uit gemeenten en deze gaat over de functionele inhoud en prioritering van de doorontwikkeling van de standaard. De technische gebruikersgroep bestaat uit leveranciers en gemeenten die zelf software ontwikkelen. In deze gebruikersgroep worden de technische details en verbeteringen van de standaard besproken. Wilt u aan één van deze werkgroepen deelnemen, dan kunt u zich aanmelden via dit online formulier.

De meest actuele API-standaarden voor zaakgericht werken (beheer en gebruik) en meer informatie is beschikbaar via: https://www.gemmaonline.nl/index.php/API-standaarden.

De afdeling Architectuur en Standaarden van VNG Realisatie heeft een helpdesk ingericht voor gebruikersondersteuning en vragen over API-standaarden, de helpdesk is bereikbaar via standaarden.ondersteuning@vng.nl

Gerelateerde thema's