Beste bezoeker,

op dit moment wordt er een nieuwe release doorgevoerd op GEMMA Online. Hierdoor is de omgeving tijdelijk niet beschikbaar.

Vragen? Stuur een e-mail naar gemmaonline@vng.nl

Met vriendelijke groet, Kenniscentrum Architectuur VNG Realisatie

Ontwikkelagenda API-standaarden

Versie door GEMMAbot (overleg | bijdragen) op 8 jul 2022 om 18:09
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Laatst bewerkt: 8 juli 2022, 18:09:12

De Ontwikkelagenda API-standaarden is een dynamisch overzicht van API-specificaties voor gegevensuitwisseling in het gemeentelijk domein. De (in ontwikkeling zijnde) API-standaarden zijn in een funnel geplaatst waarbij de status van idee tot release kandidaat en implementeerbaar is weergegeven. Sommige van de API-specificaties onder implementeerbaar zijn reeds vastgesteld en staan op de pas-toe-leg-uit lijst. Het doel van deze funnel is bestuurders, informatiemanagers, architecten en ontwikkelaars bij gemeenten en marktpartijen inzicht te geven in welke gemeente met de ontwikkeling van API-specificaties bezig is (en waar zij staan), zodat zij hier in hun planning rekening mee kunnen houden en eventueel aan deel kunnen nemen.

De API-standaarden in de ontwikkelagenda volgen het standaardisatieproces. Dit proces geeft de leidraad van te volgen stappen om onder regie van VNG Realisatie van ‘idee’ tot ‘vastgestelde VNG uitwisselstandaard’ te komen.
De ontwikkelagenda voor API-standaarden is een dynamisch overzicht en geen vaste planning voor de komende jaren. De Ontwikkelagenda wordt één maal per kwartaal geactualiseerd. Voor vragen, op- of aanmerkingen: gemmaonline@vng.nl.

API-ontwikkelagenda Juli 2022 v2.png

Basisregistraties

BAG-Bevragen

BAG Huidige bevragingen is een Haal Centraal API voor het zoeken en raadplegen van gegevens in de basisregistratie Adressen en Gebouwen voor alle binnengemeentelijke afnemers in NL, maar ook voor waterschappen, belastingsamenwerkingen en andere overheden. Deze API is gebouwd en wordt gehost door het Kadaster.
Contactpersoon: Johan Boer. Status: Versie 1.5 van de API is live. Pas-Toe-Leg-Uit.
Beheer van de specificaties bij project Haal-Centraal.
Details zijn te vinden op Github - HaalCentraal , Github - HaalCentraal BAG Bevragen en Github - code BAG Bevragen

BRP-Bevragen

BRP Bevragen is een Haal Centraal API voor het zoeken en raadplegen van ingeschreven natuurlijke personen voor alle binnengemeentelijke afnemers in NL. De informatie die de API levert is herleidbaar naar het LO GBA 3.10. Deze API zal gebouwd worden door het RvIG.
Contactpersoon: Johan Boer. Status: API-spec versie 1.3.1 beschikbaar. Pas-Toe-Leg-Uit.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRP Bevragen en Github HaalCentraal - Code BRP Bevragen

BRK-Bevragen

API voor het zoeken en raadplegen van gegevens over grondpercelen en appartementsrechten in de basisregistratie Kadaster. BRK bevragen bevat nu privaatrechtelijke en publiekrechtelijke beperkingen, hypotheken en beslagen! Deze API is gebouwd en wordt gehost door het Kadaster.
Contactpersoon: Johan Boer. Status: API-spec versie 1.5 beschikbaar. Pas-Toe-Leg-Uit.
Beheer van de specificaties bij project Haal-Centraal.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRK Bevragen en GitHub HaalCentraal Code - Bevragen

WOZ-Bevragen

De API WOZ bevragen maakt het mogelijk gegevens uit de landelijke voorziening WOZ (Waardering Onroerende Zaken) op te vragen.
Contactpersoon: Johan Boer. Status: Versie 1.0 van de API is live. Pas-Toe-Leg-Uit.
Beheer van de specificaties bij project Haal-Centraal.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - WOZ Bevragen en GitHub HaalCentraal Code - WOZ Bevragen

BRP-Bewoning

API voor het raadplegen van de (historische) bewoning van een adres, verloop op een adres, of de medebewoners van een persoon.
Contactpersoon: Johan Boer. Status: API-specificatie versie 1.0.0 in ontwikkeling beschikbaar. Er zijn enkele lokale implementatie.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRP-Bewoning en GitHub Code - BRP Bewoning

BRP-Historie

API voor het raadplegen van historische gegevens over personen. Met deze API kun je verblijfplaatshistorie, partnerhistorie, verblijfstitelhistorie en nationaliteithistorie opvragen.
Contactpersoon: Johan Boer. Status: API-specificatie versie 1.0.0 is klaar (zeer binnenkort volgt de officiële release op github).
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRP Historie en GitHub HaalCentraal Code - BRP Historie

BRP-Reisdocumenten

API voor het raadplegen van een reisdocument met een reisdocumentnummer.
Contactpersoon: Johan Boer. Status: API-specificatie versie 1.0.0 is klaar (zeer binnenkort volgt de officiële release op github).
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRP Reisdocumenten en GitHub HaalCentraal Code - BRP Reisdocumenten

BRP-Tabellen

API voor het zoeken en raadplegen van BRP landelijke tabellen.
Contactpersoon: Johan Boer. Status: API-specificatie zo goed als af. Op zoek naar een partij die deze tabellen-API kan hosten en beheren.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRP Tabellen Bevragen en GitHub HaalCentraal Code - BRP Tabellen Bevragen

BRP-Update

Migratie API waarmee je je kunt abonneren op notificaties over wijzigingen van personen. Bedoeld voor gebruik in combinatie met de BRP bevragen API, bijvoorbeeld om (tijdelijk) lokale kopiegegevens actueel te houden.
Contactpersoon: Johan Boer. Status: Beheer van de specificaties bij project Haal-Centraal.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRP Update en GitHub HaalCentraal Code - BRP Update

HR-Bevragen

API voor het zoeken en raadplegen van gegevens uit het Handelsregister.
Contactpersoon: Johan Boer. Status: In ontwikkeling in samenspraak met de Kamer van Koophandel.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - HR Bevragen en GitHub HaalCentraal Code - HR Bevragen

BGT-Bevragen

De API BGT bevragen maakt het mogelijk gegevens uit de Basisregistratie Grootschalige Topografie (BGT)op te vragen.
Contactpersoon: Johan Boer. Status: Op de backlog.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BGT Bevragen en GitHub HaalCentraal Code - BGT Bevragen

Bestuurlijk Domein

Open Raads Informatie

De Open Api Specificatie voor Open Raadsinformatie beschrijft de standaard voor het ontsluiten van Raadsinformatie van gemeenten. Een functionaliteit in het kader van de Wet Open Overheid.
Details op: GITHUB-ODS Open Raadsinformatie
Contactpersoon Johan Boer. Status: Analyse. Als gevolg van een wetswijziging moet het eerder gemaakte ontwerp herzien worden.

Open WoB

De Open Api Specificatie voor de Wet Openbaarheid van Bestuur beschrijft de standaard voor het ontsluiten van WoB-verzoeken van gemeenten. Een functionaliteit in het kader van de Wet Open Overheid.
Contactpersoon Henri Korver. Status: Analyse. Als gevolg van een wetswijziging moet het eerder gemaakte ontwerp herzien worden.

Wet hergebruik Overheidsinformatie

De herziening van de Who heeft impact op meerdere sporen. Eén van deze sporen betreft de vertaling van de Europese High Value Datalist naar de gemeentelijke variant. Op het moment van schrijven is nog niet bekend of en welke onderwerpen moeten worden behandeld. Hiervoor zal een onderzoek uitgevoerd worden. Wel is bekend dat de onderwerpen die van de E-HVDL op de gemeentelijke high valuedatalist komen verplicht vergezeld moeten worden van een API.
Contactpersoon Sander Bakker. Status: Intake

Dienstverlenings Domein

Autorisaties

Deze API laat toe om autorisaties van een (taak)applicatie te beheren en uit te lezen (mbv de autorisatiecomponent (AC)). De AUTORISATIE is het kernobject in deze API. Autorisaties worden toegekend aan applicaties. Een applicatie is een representatie van een (web) app die communiceert met de API van (andere) componenten, zoals het ZRC, DRC, ZTC en BRC.
Contactpersoon: Henri Korver. Status: implementeerbaar, momenteel wordt gewerkt aan het afsplitsen van de autorisatiecomponent tot een separaat voorkomen. Pas-Toe-Leg-Uit.
Details zijn te vinden op GITHUB - GEMMA Zaken en VNG Cloud Autorisatiecomponent (AC)

Besluiten

De besluitregistratiecomponent (BRC) helpt gemeenten om besluiten te registreren. Een BESLUIT wordt veelal schriftelijk vastgelegd maar dit is niet noodzakelijk. Omgekeerd kan het voorkomen dat in een INFORMATIEOBJECT meerdere besluiten vastgelegd zijn. Vandaar de N:M-relatie naar INFORMATIEOBJECT. Een besluit komt voort uit een zaak van de zaakbehandelende organisatie dan wel is een besluit van een andere organisatie dat het onderwerp (object) is van een zaak van de zaakbehandelende organisatie. BESLUIT heeft dan ook een optionele relatie met de ZAAK waarvan het een uitkomst is.
Contactpersoon: Michiel Verhoef. Status: Implementeerbaar. Pas-Toe-Leg-Uit
Details zijn te vinden op: GITHUB - GEMMA Zaken en VNG Cloud Besluit Registratie Component (BRC)

Catalogi

De zaaktypecatalogus ZTC helpt gemeenten om het proces vanuit de 'vraag van een klant' (productaanvraag, melding, aangifte, informatieverzoek e.d.) tot en met het leveren van een passend antwoord daarop in te richten, inclusief de bijbehorende informatievoorziening. Een CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type, standaardwaarden en processtructuur.
Contactpersoon: Michiel Verhoef. Status: implementeerbaar. Pas-Toe-Leg-Uit
Details zijn te vinden op GITHUB - GEMMA Zaken en VNG Cloud Zaaktypecatalogus (ZTC)

Contactmomenten

API voor het registreren en ontsluiten van contactmomenten tussen de klant en gemeente en de daarbij behorende metadata. Voorbeelden van een contactmoment zijn een baliebezoek of een telefonisch contact over een onderhanden zijnde zaak.
Contactpersoon: Ivo Hendriks. Status: realisatie.
Details zijn te vinden op GITHUB GEMMA Zaken - Contactmomenten API en GITHUB GEMMA Zaken issues

Documenten

De documentregistratiecomponent (DRC) helpt gemeenten om documenten vast te leggen. In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens. INFORMATIEOBJECTen kunnen aan andere objecten zoals zaken en besluiten worden gerelateerd (maar dat hoeft niet) en kunnen gebruiksrechten hebben. GEBRUIKSRECHTEN leggen voorwaarden op aan het gebruik van het INFORMATIEOBJECT (buiten raadpleging). Deze GEBRUIKSRECHTEN worden niet door de API gevalideerd of gehandhaafd. De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in de vorm van INFORMATIEOBJECTTYPEn.
Contactpersoon: Michiel Verhoef. Status: Implementeerbaar. Pas-Toe-Leg-Uit
Details zijn te vinden op GITHUB - GEMMA Zaken en VNG Cloud - Document Registratie Component (DRC)

Klanten

API voor registratie en ontsluiting van klanten en de daarbij behorende metadata. Klanten kunnen zowel burgers als bedrijven zijn. Authentieke gegevens (zoasl bsn, rsin, etc.) zijn niet verplicht zodat klanten snel en gemakkelijk geregistreerd kunnen worden. Deze API is de basis voor: Contactmomenten API en Verzoeken API.
Contactpersoon: Ivo Hendriks. Status: realisatie.
Details zijn te vinden op GITHUB - Klanten API en GITHUB - GEMMA Zaken issues]

Medewerker

API om medewerker- en afdelingsgegevens te ontsluiten.
Contactpersoon: Michiel Verhoef. Status: Idee.

ZGW Notificaties

Een API om een notificatierouteringscomponent te benaderen. Deze API voorziet in drie functionaliteiten voor notificaties: registreren van kanalen (=exchanges), abonneren van consumers op kanalen, en ontvangen en routeren van berichten.
Contactpersoon: Gershon Janssen. Status: implementeerbaar. Pas-Toe-Leg-Uit
Details zijn te vinden op GITHUB - GEMMA Zaken en VNG Cloud - Notificatie Routering Component (NRC)
In een landelijk project wordt momenteel gewerkt aan een landelijke standaard. Zie ook Notificeren berichtenstandaard.

Selectielijst

Contactpersoon: Michiel Verhoef. Status: Idee.

Productaanvragen

API voor de registratie en ontsluiting van producten. Het betreft een aanvraag van een klant aan de gemeente (of andere overheid) voor de levering van een product of dienst. Een product aanvraag kan leiden tot een zaak maar kan ook op een andere manier afgehandeld worden.
Contactpersoon: Ivo Hendriks. Status: realisatie.
Details zijn te vinden op GITHUB GEMMA Zaken Verzoeken API en GITHUB GEMMA Zaken issues

Zaken

De ZAAK is het kernobject in deze API, waaraan verschillende andere resources gerelateerd zijn. De Zaken API werkt samen met andere API's voor Zaakgericht werken om tot volledige functionaliteit te komen. In ieder geval dienen de volgende API's beschikbaar te zijn:

  • Catalogi API
  • Notificaties API
  • Documenten API (optioneel)
  • Besluiten API (optioneel)
  • Autorisaties API (optioneel)


Contactpersoon: Michiel Verhoef. Status: implementeerbaar. Pas-Toe-Leg-Uit
Details zijn te vinden op GITHUB - GEMMA zaken

Overige Objecten Registratie

De Object API heeft als doel om uiteenlopende typen objecten op een dynamische wijze te standaardiseren op landelijk niveau en om te voorkomen dat voor elk (eenvoudig) object een volledig nieuwe API wordt opgezet. Het betreft de volgende API specificaties:

  • Objecten API specificatie
  • Objecttypen API specificatie

Common Ground beoogd het ophalen van Data bij de Bron. Er zijn allerlei landelijke bronregistraties voorhanden, die de komende tijd ontsloten worden. Voor de gemeentelijke dienstverlening zijn echter ook een groot aantal registraties nodig voor objecten die niet in basisregistraties staan (de boom, prullenbak). Deze objectregistraties hebben vaak dezelfde structuur: een prullenbak (het object) met kenmerken (plaats, kleur, eigenaar, …).
Deze standaard definieert “recht toe recht aan” registraties middels:

  • Een beschrijving van het object, de kenmerken en relaties met andere registraties (objecttype api, definieert de inrichting van het register).
  • De manier waarop deze kenmerken opgeslagen en opgevraagd kunnen worden (objecten api , toegang tot het register).

Contactpersoon: De open-zaak community vertegenwoordigd door Lazo Bozarov (gemeente Utrecht).
Status: implementeerbaar. Pas-Toe-Leg-Uit.
Details: op Github.com:

PDC

Iedere organisatie die producten en/of diensten levert aan haar ‘klanten’ en ketenpartners neemt de specificaties van die producten en diensten op en maakt die toegankelijk in eigen producten- en dienstencatalogi. Een organisatie kan één producten- en dienstencatalogus aanbieden voor al haar producten en diensten maar kan dat ook doen in meerdere catalogi, bijvoorbeeld een catalogus per domein (dienstverlening, ruimtelijk domein, sociaal domein et cetera).
In het SDG project wordt gewerkt aan een centrale voorziening waarin gemeenten de onder de SDG verordening vallende producten en diensten in het Nederlands en Engels kunnen beschrijven. Deze voorziening kan een opmaat zijn naar een (centrale) PDC API voor het ontsluiten van alle gemeentelijke producten en diensten.
Contactpersoon: Ivo Hendriks. Status: Idee

Fysiek Domein

Regels bij Activiteiten

De API maakt het mogelijk om gegevens op te vragen bij een plansoftware-applicatie over (Omgevingswet-)activiteiten en/of (bijbehorende) juridische regels, regelteksten en locaties. Beoogd gebruik is vooral het inzicht krijgen in deze gegevens door een toepasbare regelsoftware-applicatie, t.b.v. het kunnen opstellen en aanpassen van toepasbare regels. Naast het gebruik als API is ook voorzien in de mogelijkheid tot bestandsuitwisseling van genoemde gegevens van plansoftware naar toepasbare regelsoftware ('JR-TR-koppeling').
Contactpersoon: Robert Melskens. Status: implementeerbaar. Pas-Toe-Leg-Uit
Details op: VNG-Github - Regels-bij-activiteiten.

Digitale Terinzagelegging

De Digitale Terinzagelegging API voorziet in functionaliteit die nodig is om te kunnen voldoen aan de wettelijke verplichtingen ten aanzien van (digitaal) ter inzage leggen. Middels deze Digitale Terinzagelegging API kunnen applicaties die documenten ter inzage willen leggen bij de officiële publicatie (op officielebekendmakingen.nl) documenten plaatsen en verwijderen. De API voorziet tevens in de optie om het platform te gebruiken als tussenstation voor het 3PAS-koppelvlak van KOOP.
Dit standaardisatie-initiatief komt van de leveranciers Gemboxx, Genetics, Stadsbeheer en Centric.
Contactpersoon: Eddy van de Werken (Centric) / Willam van Weelden (Centric). Status: realisatie.

Erfgoedregistratie

De Werkgroep De Data-Beet heeft een standaard laten ontwikkelen om gegevens over gemeentelijk Erfgoed gestandaardiseerd uit te wisselen. Voor meer informatie zie Werkgroep De Data-Beet.
Contactpersoon: Paul Jansen. Status: Idee

Generieke standaarden

Logging van Verwerkingen

Organisaties die persoonsgegevens verwerken zijn conform de Algemene Verordening Gegevensbescherming (AVG) en de Uitvoeringswet AVG verplicht om aan te kunnen tonen dat een verwerking van persoonsgegevens aan de belangrijkste beginselen van verwerking voldoet, zoals rechtmatigheid, transparantie, doelbinding en juistheid. Om aan deze verantwoordingsplicht te kunnen voldoen is het van belang dat per verwerking de belangrijkste metagegevens van de verwerkingen worden vastgelegd. Standaardisatie van de vastlegging van verwerkingen is van belang om de eenduidigheid en toegankelijkheid van deze gegevens te borgen. Door VNG-Realisatie is deze Logging van Verwerkingen API-standaard ontwikkeld als onderdeel van de GEMMA referentiearchitectuur. Deze API-standaard biedt leveranciers van informatiesystemen gestandaardiseerde API-specificaties voor het vastleggen en ontsluiten van de logging van verwerkingen zowel van persoonsgegevens als van gegevens van andere objecten.
Contactpersoon: Arnoud Quanjer. Status: Realisatie
Details op: https://github.com/VNG-Realisatie/gemma-verwerkingenlogging/

Verwerkingsactiviteiten

Conform de Algemene Verordening Gegevensbescherming (AVG) moet iedere organisatie of persoon die zich niet incidenteel bezighoudt met het verwerken van persoonsgegevens een een verwerkingsregister (register van de verwerkingsactiviteiten) hebben. In dit register worden metagegevens bijgehouden ten aanzien van specifieke verwerkingsactiviteiten. Voorbeelden hiervan zijn de wettelijke grondslag van de verwerking, het doel van de verwerking en de categorieen van persoonsgegevens die verwerkt worden.

Via de Verwerkingsactiviteiten-API worden de verwerkingsactiviteiten en hun bijbehorende metagegevens op een gestandaardiseerde wijze uit het gemeentelijk verwerkingsregister ontsloten. Deze API kan onder andere gebruikt worden om de burger een overzicht te bieden van de verwerkingsactiviteiten die door de gemeente worden uitgevoerd. Ook kan deze API gebruikt worden om de metagegevens van verwerkingsactiviteiten waaraan in een verwerkingenlog via verwerkingsactiviteit-Ids wordt gerefereerd op te halen.
Contactpersoon: Arnoud Quanjer. Status: intake.

Notificeren Berichtenstandaard

Project met als doel het maken van een landelijke notificatiestrategie met o.a. afspraken, standaarden en handreikingen voor het notificeren van applicaties over plaatsgevonden gebeurtenissen die hebben geleid tot wijzigingen binnen registraties.
Contactpersoon: Gershon Janssen. Status: realisatie.
Details op: Community pagina op Pleio

Sociaal Domein

Info Inburgeraars

Initiatief van een aantal partijen om via open source een oplossing te bieden voor communicatie met (in eerste instantie) taalaanbieders in het kader van de nieuwe inburgeringswet. De oplossing is een combinatie van API en portal uitwisseling. Ze concentreren zich in eerste instantie op processen die de meeste administratieve last vragen; uitwisseling met taalinstellingen en willen zo verder werken naar de andere gebieden (denk aan maatschappelijke instellingen voor MAP, maatschappelijke begeleiding etc).
Contactpersoon: Ronald de Zwart. Status: idee.

Uitwisseling Matchingsgegevens

Op het TWI platform wordt de uitwisselingsvoorziening VUM gerealiseerd en beschikbaar gesteld. De VUM-uitwisselingsvoorziening verzorgt de uitwisseling van gestandaardiseerde gegevens over organisatiegrenzen heen. Die uitwisseling van werkzoekenden profielen vindt plaats tussen de bestaande systemen die bemiddelaars gebruiken om onderling gegevens te matchen.
Contactpersoon: Ronald de Zwart. Status: analyse.