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

Laatst bewerkt: 12 juli 2021, 15:02:18

(Status: Actueel / Laatst bijgewerkt op: 6-5-2021)

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: Lia.deZoete@vng.nl.

TR: Bureau naar GemeenteJR/VTHAOW LeeftijdSelectielijstMedewerkerKoppelvlak Sociaal DomeinJR: Bureau naar GemeenteRegiser Externe VeiligheidBrief opmakenStandaard eMailOpen WebBGT-BevragenHR-BevragenWOZ-BevragenBRP-UpdatePDCNotificeren ontwerp standaardVerzoekenKlantenContact momentenBRK-UpdateBRP-BewoningOverige Objecten RegistratieBRP TabellenBRP-BevragenOpen Raads InformatieRegels bij ActiviteitenLogging van verwerkingenBesluitenCatalogiZGW-notificatiesBAG-BevragenBRP-ReisdocumentenZakenDocumentenAuthorisatieBRK-bevragenBRP-historieOntwikkelagenda API-standaarden.png
Over deze afbeelding



Fasering

Op de bij deze Ontwikkelagenda behorende Governance pagina is de Fasering toegelicht..

Basisregistraties (HaalCentraal)

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.1. van de API is live. 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.1 beschikbaar. RvIG doet een POC. Den Haag heeft lokaal geïmplementeerd. Diverse leveranciers zijn hiermee bezig..
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRP Bevragen en Github HaalCentraal - Code BRP 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: In ontwikkeling.
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

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: Versie 1.2 van de API is live. 1.3 binnenkort live. Beheer van de specificaties bij project Haal-Centraal.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRK Bevragen en GitHub HaalCentraal Code - Bevragen

BRK-event-sourcing

POC om te bepalen of event-sourcing een vervanger zou kunnen zijn voor de BRK-Levering.
Contactpersoon: Johan Boer. Status: HC-interne POC uitgevoerd. Resultaat wordt meegenomen in project Notificatie Services.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - en GitHub HaalCentraal Code - BRK-Event Sourcing

BRK-update

Zie BRK event sourcing.
Details zijn te vinden op Github - HaalCentraal , Github HaalCentraal - BRK Update en GitHub HaalCentraal Code - BRK 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

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.1. van de API is live. 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

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: Release Kandidaat

Dienstverlenings Domein

AOW leeftijd

De wens om een API te ontwikkelen waar je de datum van vandaag in gooit (of een datum in het verleden), waarna die API de geboortedatum teruggeeft van de jongste persoon die op die datum recht op AOW heeft. Zo kan je die grensdatum vergelijken met een geboortedatum die je op dat moment als procesgegeven beschikbaar hebt. Privacy by Design.
Contactpersoon: .
Status: idee.
Details zijn te vinden op SVB - Uw AOW Leeftijd

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.
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)

Brief opmaken

Als gebruiker wil ik een brief maken, zodat ik een organisatie op een passende manier informeer.
Contactpersoon: Bauke Huijbers. Status: Eerste idee ontstaan bij 'Huishoudboekje'.
Details zijn te vinden op GitLab - Huishoudboekje

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: Henri Korver. Status: wordt gerealiseerd, eind 2020 beschikbaar.
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: Henri Korver. Status: wordt gerealiseerd, eind 2020 beschikbaar.
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.

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: Michiel Verhoef. Status: implementeerbaar.
Details zijn te vinden op GITHUB - GEMMA Zaken en VNG Cloud - Notificatie Routering Component (NRC)

Selectielijst

Contactpersoon: Michiel Verhoef. Status: Idee.

Standaard eMail

Wens voor een standaard eMail functionaliteit.
Contactpersoon: Arnoud Quanjer. Status: Eerste idee.

Verzoeken

API voor de registratie en ontsluiting van verzoeken. Een verzoek is een aanvraag van een klant aan de gemeente (of andere overheid) voor de levering van een product of dienst. Een verzoek kan leiden tot een zaak maar kan ook op een andere manier afgehandeld worden.
Contactpersoon: Henri Korver. Status: in ontwikkeling.
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.
Contactpersoon: Michiel Verhoef. Status: implementeerbaar. Pas-Toe-Leg-Uit
Details zijn te vinden op GITHUB - GEMMA zaken

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').

Details op: VNG-Github - Regels-bij-activiteiten.
Contactpersoon: Robert Melskens. Status: Release kandidaat

JR/VTH

Uitwisselen informatie juridische regels ten behoeve van het verlenen van vergunningen en andersom het verstrekken van informatie over vergunningen voor het aanpassen van regels in het omgevingsplan

JR: Bureau naar Gemeente

Publiceren van wijziging omgevingsplan van Bureau naar Gemeenten op basis van STOP-TPOD standaard

TR: Bureau naar Gemeente

Exporteren van Toepasbare Regels van Bureau naar Gemeente op basis van STTR standaard

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, ingedeeld naar domeinen d.w.z. per domein (ruimtelijk domein, sociaal domein et cetera) een aparte catalogus.
Contactpersoon: Henri Korver. Status: Ontwerp

Overige Objecten Registratie

Flexibele oplossing om snel kleine registraties op te zetten.
Contactpersoon: Ivo Hendriks. Status: Bij een aantal Gemeenten is deze API in de maak. We gebruiken deze API om binnen het raamwerk standaardisatie het adoptieproces vorm te geven.

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 de Verwerkingenlogging 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.

Details op: https://github.com/VNG-Realisatie/gemma-verwerkingenlogging/
Contactpersoon: Arnoud Quanjer. Status: Release Kandidaat.

Verwerkingsactiviteiten

Gemeenten hebben vanuit de privacywetgeving (AVG) de verplichting om een register van verwerkingsactiviteiten te voeren. In dit register worden de doeleinden en grondslagen vastgelegd voor de verwerking van (persoons)gegevens. De Verwerkingsactiviteiten API-standaard ontsluit de gegevens uit het verwerkingsregister die voor de AVG-verantwoordingsplicht van belang zijn. Met behulp van de functies uit deze API-standaard is het mogelijk om de inhoud van het gemeentelijk verwerkingsactiviteitenregister op de gemeentelijke website te publiceren en het is mogelijk om de inhoud van het register te combineren met de gegevens die ten aanzien van verwerkingen van (persoons)gegevens in het gemeentelijk verwerkingenlog zijn vastgelegd.
Contactpersoon: Arnoud Quanjer. Status: in ontwikkeling.

Notificeren ontwerp standaard

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

Koppelvlakken Sociaal Domein

Het Sociaal Domein staat in het teken van ketensamenwerking. De Gemeenten spelen daarin een centrale rol. Er zullen onder andere ketens ontstaan op Inkomen, Werk, Schulden en Inburgering.
Contactpersoon: Ronald de Zwart. Status: analyse.
Details op:https://vng-realisatie.github.io/gemma-zaken/