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

De API-standaarden 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 klantcontacten) 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 zaakgegevens uit te wisselen tussen 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 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, klantcontacten. Al deze gegevens kunnen worden bevraagd en bijgewerkt via API’s.

Zaakgericht werken API overzicht

De standaarden zijn ontwikkeld als RESTful API’s, die aansluiten bij de landelijke API-strategie. RESTful 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.

Aan de slag met API-standaarden voor Zaakgericht Werken

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.

Implementatieondersteuning

VNG Realisatie biedt implementatieondersteuning voor gemeenten die (bij voorkeur gezamenlijk en in samenwerking met hun leveranciers) aan de slag willen met de API-standaarden voor Zaakgericht Werken.