ZGW API koppeling laten maken
Appfront bouwt maatwerk koppelingen met de ZGW API's: de standaard voor zaakgericht werken binnen Common Ground. We verbinden uw taakapplicatie, website of zaaksysteem met de Zaken API (ZRC), Documenten API (DRC), Catalogi API (ZTC), Besluiten API (BRC) en Notificaties API (NRC). Zo werkt u met gegevens bij de bron — conform de Nederlandse API-strategie, met autorisaties per zaaktype en realtime notificaties.
Wat zijn de ZGW API's?
De ZGW API's zijn de VNG-standaard voor zaakgericht werken binnen Common Ground. Ze vervangen de oudere, SOAP-gebaseerde StUF-/ZDS-koppelvlakken door een set samenhangende REST/JSON-API's. De kerncomponenten zijn de Zaken API (ZRC) voor zaken, de Documenten API (DRC) voor documenten, de Catalogi API (ZTC) voor zaaktypen, de Besluiten API (BRC) voor besluiten en de Notificaties API (NRC) voor gebeurtenissen. Autorisatie wordt geregeld via de Autorisaties API (AC).
De achterliggende gedachte van Common Ground is dat applicaties en gegevens worden gescheiden: zaakgegevens, documenten en zaaktypen staan in aparte registers die rechtstreeks via API's worden bevraagd en bijgewerkt, in plaats van gekopieerd tussen systemen. Een maatwerk koppeling betekent in de praktijk: zaken aanmaken en bijwerken, documenten koppelen, zaaktypen uit de catalogus uitlezen, besluiten vastleggen en via abonnementen op de Notificaties API direct reageren op wijzigingen.
Appfront bouwt volgens de officiële gemma-zaken documentatie van VNG Realisatie en de OWASP ASVS security standaard. We stemmen de koppeling, de autorisaties per zaaktype en de foutafhandeling af op uw werkelijke processen, zodat de integratie ZGW-conform blijft en meegroeit met nieuwe versies van de standaard.
Gegevens bij de bron
Zaken, documenten en besluiten staan in aparte registers en worden rechtstreeks via de API bevraagd en bijgewerkt. Geen kopieën die uit de pas lopen, maar één actuele waarheid die elke gekoppelde applicatie deelt.
Realtime notificaties
Via de Notificaties API (NRC) abonneert u zich op gebeurtenissen — een nieuwe zaak, een statuswijziging of een toegevoegd document. Gekoppelde applicaties reageren direct, zonder te hoeven pollen.
Autorisatie per zaaktype
De Autorisaties API (AC) bepaalt welke applicatie welke zaaktypen mag zien en bewerken, met scopes en een maximale vertrouwelijkheidsaanduiding. Gegevens worden bij de bron gefilterd volgens privacy-by-design.
Ons ontwikkelproces voor ZGW API koppelingen
We werken volgens een bewezen methodiek die onzekerheid vroeg wegneemt en een stabiele, ZGW-conforme koppeling oplevert. Van een eerste analyse van uw zaaktypen, processen en bestaande zaaksysteem tot livegang en doorlopend beheer — elke stap is gericht op een koppeling die uw organisatie zelf kan begrijpen en vertrouwen.
We brengen in kaart welke processen en zaaktypen u wilt ondersteunen, welke ZGW-componenten (ZRC, DRC, ZTC, BRC, NRC) nodig zijn, welke autorisaties gelden en of er vanuit StUF gemigreerd moet worden.
We ontwerpen de koppelarchitectuur conform de Nederlandse API-strategie, richten JWT-authenticatie en autorisaties per zaaktype in en stellen een foutafhandelings- en notificatiestrategie op.
Implementatie tegen de ZGW-standaard met automated tests, gestructureerde logging en monitoring. U krijgt tussentijds werkende builds te zien, getoetst aan de referentie-implementatie.
Gecontroleerde livegang met data-validatie en vangnet, gevolgd door doorlopend beheer en het meegroeien met nieuwe versies van de standaard.
Wat een ZGW API koppeling concreet oplevert
Elke ZGW-koppeling wordt specifiek ingericht voor uw processen, zaaktypen en aangrenzende systemen. Hieronder de functionaliteiten die we het vaakst opleveren voor overheidsorganisaties die zaakgericht werken via de ZGW API's.
Zaken aanmaken & bijwerken (ZRC)
Via de Zaken API maken we zaken aan, koppelen we rollen, statussen en resultaten en werken we de zaakvoortgang bij. Uw taakapplicatie of website kan zo een aanvraag direct als zaak registreren in de centrale zaakregistratie.
Documenten koppelen (DRC)
Met de Documenten API koppelen we informatieobjecten aan zaken: aanvragen, bijlagen, beschikkingen en correspondentie. Metadata, vertrouwelijkheid en versies worden conform de standaard vastgelegd en aan de juiste zaak verbonden.
Zaaktypen uit de catalogus (ZTC)
De Catalogi API ontsluit zaaktypen, statustypen, resultaattypen en eigenschappen. Uw applicatie leest deze definities uit, zodat formulieren en processtappen automatisch aansluiten op de ingerichte zaaktypecatalogus.
Besluiten vastleggen (BRC)
Met de Besluiten API leggen we genomen besluiten vast en koppelen we ze aan de bijbehorende zaak en documenten. Voor vergunningen, beschikkingen en handhavingsbesluiten ontstaat zo een sluitend en herleidbaar dossier.
Notificaties & abonnementen (NRC)
De Notificaties API stuurt gebeurtenissen door naar gekoppelde applicaties. We richten kanalen en abonnementen in en verwerken inkomende notificaties via webhooks, zodat processen direct reageren op een nieuwe of gewijzigde zaak.
Autorisaties & StUF-migratie
We beheren rechten via de Autorisaties API met scopes en vertrouwelijkheidsaanduiding per zaaktype, en bouwen waar nodig een vertaallaag tussen bestaande StUF-/ZDS-koppelvlakken en de ZGW API's, zodat oude en nieuwe systemen tijdens de migratie samen blijven werken.
Typische toepassingen in de praktijk
Een ZGW API koppeling pakt per organisatie verschillend uit. Een aantal patronen zien we vaak terugkomen binnen de overheid — en voor elk daarvan hebben we een werkende opzet met aandacht voor zaaktypen, autorisaties en de juiste procesafhandeling.
Zaaksystemen bij gemeenten
Gemeenten die zaakgericht werken en hun zaaksysteem, website of mid-office willen koppelen aan de ZGW API's. Aanvragen worden als zaak geregistreerd, documenten gekoppeld en de voortgang teruggekoppeld. Zie ook onze software voor gemeenten en gemeente-website.
Vergunningen, toezicht & handhaving
Omgevingsdiensten en VTH-afdelingen die vergunningaanvragen, toezichtdossiers en handhavingsbesluiten zaakgericht afhandelen. Zaken (ZRC), documenten (DRC) en besluiten (BRC) vormen samen een sluitend dossier, met notificaties richting betrokken taakapplicaties. Relevant ook voor waterschappen.
Migratie van StUF naar Common Ground
Organisaties die bewegen van de oudere, SOAP-gebaseerde StUF-/ZDS-koppelvlakken naar de moderne ZGW API's. We brengen het bestaande berichtenverkeer in kaart, bouwen waar nodig een adapter of vertaallaag en laten oude en nieuwe systemen tijdens de overgang naast elkaar functioneren. Zie onze StUF-koppeling.
Taakapplicaties koppelen aan de zaakregistratie
Specialistische taakapplicaties — voor bijvoorbeeld meldingen openbare ruimte, subsidies of bezwaar — die als consumer of provider met de centrale zaakregistratie communiceren. Elke applicatie werkt met dezelfde gegevens bij de bron, gecombineerd met onze Haal Centraal-koppeling voor brongegevens.
Technologie die we inzetten
ZGW-koppelingen bouwen we tegen de officiële standaard van VNG Realisatie: RESTful API's met JSON, conform de Nederlandse API-strategie. Authenticatie verloopt via JWT en de Autorisaties API; voor wijzigingen gebruiken we de Notificaties API. De backend-stack stemmen we af op uw landschap, zodat uw eigen team of leverancier de koppeling kan beheren.
Waarom Appfront voor uw ZGW API koppeling?
Appfront heeft ruime ervaring met het bouwen van API-integraties voor uiteenlopende organisaties in Nederland. We beginnen altijd met een grondige analyse van de bestaande systemen en processen — een koppeling moet niet alleen technisch kloppen, maar ook praktisch waarde toevoegen aan uw werkwijze.
Bij elke integratie schrijven we heldere documentatie en zorgen we dat uw eigen team — of een toekomstige leverancier — de koppeling kan begrijpen en beheren. Geen black box, maar transparante code en duidelijke afspraken over monitoring, alerting en beheer.
U werkt samen met een vast aanspreekpunt dat zowel de technische als de functionele kant begrijpt. Dat houdt de lijnen kort, voorkomt miscommunicatie en versnelt beslissingen wanneer er tijdens de bouw keuzes gemaakt moeten worden.
Bekijk ook onze bredere diensten rond maatwerk software, AI voor gemeenten en overheid en onze andere overheidskoppelingen, zoals de Digikoppeling-koppeling. Vragen over uw situatie? Neem gerust contact op.
- Ervaring met de ZGW API's (ZRC, DRC, ZTC, BRC, NRC) en de Autorisaties API
- Bouwen conform de Nederlandse API-strategie en Common Ground
- Vertrouwd met JWT-authenticatie, autorisaties per zaaktype en notificatie-abonnementen
- Ervaring met migratie van StUF/ZDS naar de ZGW-standaard
- Gestructureerde foutafhandeling en retry-mechanismen
- Uitgebreide logging en monitoring vanaf dag één
- Heldere documentatie die uw organisatie kan lezen en beheren
- Vast aanspreekpunt, geen doorgeschoven accountmanagers
- Doorlopend beheer en meegroeien met nieuwe versies van de standaard
- Werkwijze afgestemd op uw bestaande IT-landschap
Security en privacy bij ZGW API koppelingen
Zaakgegevens bevatten vrijwel altijd persoonsgegevens en bedrijfsgevoelige informatie. De ZGW-standaard is daarom opgezet met privacy-by-design: een provider filtert gegevens bij de bron op basis van de autorisaties in de Autorisaties API, met scopes en een maximale vertrouwelijkheidsaanduiding per zaaktype. Appfront bouwt daarbovenop volgens de OWASP ASVS: JWT's met korte geldigheid, secrets in secure vaults, scheiding van rechten per component en regelmatige audits op de koppelvlakken.
Authenticatie verloopt met een JSON Web Token op basis van een client-id en secret, meegestuurd in de Authorization-header als Bearer-token; verkeer loopt over TLS. Wij documenteren de datastromen, zaaktypen en autorisaties zodat uw verwerkingsregister compleet is en u aantoonbaar voldoet aan de AVG. Voor overheidsorganisaties sluiten we waar van toepassing aan op uw normenkaders, zoals de BIO.
Meer over onze aanpak van security: informatiebeveiligingsbeleid en CVD-beleid.
- AVG-conforme gegevensverwerking en -minimalisatie
- Filtering bij de bron via de Autorisaties API (privacy-by-design)
- JWT-authenticatie met scopes en vertrouwelijkheidsaanduiding per zaaktype
- Encryptie in transit (TLS 1.2+) en at rest
- Auditlogs met traceerbare datastromen
- Monitoring en alerting voor afwijkingen
- Secrets management volgens best practices
- Documentatie voor uw verwerkingsregister
Veelgestelde vragen over ZGW API koppelingen
Antwoorden op de vragen die we het vaakst krijgen over koppelingen met de ZGW API's.
De ZGW API's zijn de standaard API's voor zaakgericht werken van VNG Realisatie, ontwikkeld binnen Common Ground. Het is een set samenhangende REST/JSON-API's: de Zaken API (ZRC) voor zaken, de Documenten API (DRC) voor documenten, de Catalogi API (ZTC) voor zaaktypen, de Besluiten API (BRC) voor besluiten en de Notificaties API (NRC) voor gebeurtenissen. Autorisatie loopt via de Autorisaties API (AC). Samen vervangen ze de oudere StUF-/ZDS-koppelvlakken en maken ze het mogelijk om gegevens bij de bron te bevragen en bij te werken in plaats van te kopiëren tussen applicaties.
We koppelen met alle kerncomponenten van de ZGW-standaard: de Zaken API (ZRC), Documenten API (DRC), Catalogi API (ZTC), Besluiten API (BRC) en Notificaties API (NRC), plus de Autorisaties API (AC) voor het beheren van rechten. Afhankelijk van uw situatie sluiten we aan op een bestaande referentie- of leveranciersimplementatie van de standaard, of bouwen we een taakapplicatie die als consumer of provider met deze API's communiceert.
Dat hangt af van het aantal componenten, het aantal zaaktypen en de mate van maatwerk in de proceslogica. Een gerichte koppeling met de Zaken API en Documenten API voor één proces is een overzichtelijk traject; een volledige integratie over ZRC, DRC, ZTC, BRC en NRC met notificatie-abonnementen en autorisaties per zaaktype vraagt meer tijd. Na een intakegesprek geven we u een realistische inschatting.
De ZGW API's zijn RESTful API's met JSON, conform de Nederlandse API-strategie en de API Design Rules. Authenticatie verloopt met een JSON Web Token (JWT) op basis van een client-id en secret, meegestuurd in de Authorization-header als Bearer-token. Autorisaties per zaaktype, scope en vertrouwelijkheidsaanduiding worden geregeld via de Autorisaties API. Voor het verwerken van wijzigingen gebruiken we de Notificaties API met abonnementen en webhooks. De backend bouwen we in de stack die bij u past, zoals Python, Node.js, .NET of PHP.
De kosten worden bepaald door het aantal te koppelen componenten, het aantal zaaktypen en processen, de gewenste autorisatie- en notificatielogica en de hoeveelheid maatwerk in de procesafhandeling. Ook doorlopend beheer, monitoring en het meegroeien met nieuwe versies van de standaard spelen mee. We maken altijd een heldere offerte na een vrijblijvende analyse van uw situatie.
Ja. De ZGW-standaard is opgezet met privacy-by-design: de provider filtert gegevens bij de bron op basis van de autorisaties in de Autorisaties API, met scopes en een maximale vertrouwelijkheidsaanduiding per zaaktype. Appfront bouwt daarbovenop volgens OWASP ASVS: JWT's met korte geldigheid, secrets in secure vaults, TLS, scheiding van rechten per component en uitgebreide logging. We documenteren de datastromen zodat uw verwerkingsregister compleet blijft en u aantoonbaar aan de AVG voldoet.
Ja. Veel organisaties bewegen van de oudere, SOAP-gebaseerde StUF-/ZDS-koppelvlakken naar de moderne ZGW API's binnen Common Ground. We brengen uw bestaande StUF-berichtenverkeer en zaaktypen in kaart, ontwerpen de doelarchitectuur op de ZGW-standaard en bouwen waar nodig een vertaallaag of adapter, zodat oude en nieuwe systemen tijdens de overgang naast elkaar kunnen blijven werken.
De ZGW API's zijn bedoeld voor de Nederlandse overheid die zaakgericht werkt: gemeenten, omgevingsdiensten, waterschappen en uitvoeringsorganisaties. Typische toepassingen zijn zaaksystemen, vergunningverlening en VTH (vergunningen, toezicht en handhaving), het koppelen van taakspecifieke applicaties aan een centrale zaakregistratie, en de overgang van StUF naar Common Ground. Ook softwareleveranciers die hun product ZGW-conform willen maken kunnen bij ons terecht.
Klaar om uw ZGW API koppeling te laten maken?
Vertel ons welke processen en zaaktypen u zaakgericht wilt ondersteunen en met welke ZGW-componenten u wilt koppelen — we denken graag mee over de Zaken, Documenten, Catalogi, Besluiten en Notificaties API's, autorisaties en een eventuele migratie vanuit StUF. Een vrijblijvend eerste gesprek geeft u snel een scherp beeld van de mogelijkheden.