Skip to content
API's voor Zaakgericht werken
Python HTML JavaScript Shell CSS Dockerfile Batchfile
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github 🔧 Renamed Github template files. Aug 14, 2019
bin 📝 Added doc to the generate_admin_index script Mar 13, 2020
build 🏗 Adding JS stack for complex admin UI Jan 3, 2020
deployment 🔖 Bump version and update changelog Mar 13, 2020
docs 📝 Added the minimum versions of libraries Mar 13, 2020
fixtures Added APICredential and Applicatie to fixtures for newman tests Nov 28, 2019
fixtures_notificaties Fixed newman tests in travis Nov 8, 2019
log initial upload of ZRC code Jul 31, 2019
requirements remove django-formtools Mar 23, 2020
src 🗃 Add missing migration Mar 26, 2020
.babelrc move prism to npm Jan 24, 2020
.bumpversion.cfg 🔖 Bump version and update changelog Mar 13, 2020
.dockerignore 🙈 Don't send large directories to Docker daemon during builds Jan 27, 2020
.editorconfig initial upload of ZRC code Jul 31, 2019
.env-example Make logging configurable Jan 22, 2020
.gitignore 🐛 Fixes #460 -- Don't check for type overlap if not needed. Feb 4, 2020
.pep8 initial upload of ZRC code Jul 31, 2019
.pylintrc initial upload of ZRC code Jul 31, 2019
.travis.yml 🐳 Specify correct docker-compose file Feb 17, 2020
AUTHORS 📝 More precise team list Feb 17, 2020
CHANGELOG.rst 🔖 Bump version and update changelog Mar 13, 2020
CONTRIBUTING.md 🚚 Rename CONTRIBUTE to CONTRIBUTING Feb 17, 2020
Dockerfile 🐳 Ensure version is properly displayed Feb 17, 2020
Gulpfile.js initial upload of ZRC code Jul 31, 2019
LICENSE.md 📝 Small documentation changes. Dec 23, 2019
README.rst 🔖 Bump version and update changelog Mar 13, 2020
appstore.yaml Added Common Ground Appstore config file. Jan 23, 2020
docker-compose.travis.yml 👽 Things changed in in Postgres 11 alpine image w/r to auth Feb 17, 2020
docker-compose.yml 🚚 Reverse includes vs. envs package Aug 30, 2019
package-lock.json ⬆️ Bump acorn from 5.7.3 to 5.7.4 Mar 16, 2020
package.json 🔖 Bump version and update changelog Mar 13, 2020
publiccode.yaml Added initial publiccode file Jan 23, 2020
setup.cfg 🔧 Define current-version role variables Jan 27, 2020
webpack.config.js 🏗 Adding JS stack for complex admin UI Jan 3, 2020

README.rst

Open Zaak

Productiewaardige API's voor Zaakgericht Werken

Version:1.1.1
Source:https://github.com/open-zaak/open-zaak
Keywords:zaken, zaakgericht werken, zaken-api, catalogi-api, besluiten-api, documenten-api
PythonVersion:3.7

atp Build status Documentation Status Coverage black docker

Deze repository bevat broncode en documentatie voor productiewaardige API's voor Zaakgericht Werken (ZGW). Deze API's volgen de standaard van VNG Realisatie "API's voor Zaakgericht Werken".

Zaakgericht Werken

Zaakgericht werken is een vorm van procesgericht werken die door de Nederlandse gemeenten, en steeds meer landelijke overheden, wordt toegepast om verzoeken van burgers en bedrijven te behandelen. De zaak staat hierbij centraal. Een zaak is een samenhangende hoeveelheid werk met een gedefinieerde aanleiding en een gedefinieerd resultaat waarvan kwaliteit en doorlooptijd bewaakt moeten worden. De API's voor Zaakgericht Werken ondersteunen de registratie van alle metadata en gegevens die komen kijken bij Zaakgericht Werken. Zie ook Zaakgericht werken in het gemeentelijk gegevenslandschap.

Standaard "API's voor Zaakgericht Werken"

In het kader van Common Ground heeft VNG Realisatie deze standaard ontwikkeld. Daarbij zijn tegelijk met API-specificaties referentie-implementaties gerealiseerd om aan te tonen dat de specificaties in software kunnen worden geïmplementeerd. De volgende inhoudelijke API's maken onderdeel uit van de standaard:

  • Catalogi - voor de registratie van zaaktype-catalogi, zaaktype en alle daarbij horende typen.
  • Zaken - voor de registratie van zaken. Zaken kunnen o.a. relaties hebben met documenten, besluiten, contacten. De API biedt functionaliteit voor audit trail en archiveren.
  • Documenten - voor de registratie van informatieobjecten, hetgeen zowel documenten als andere informatiedragers zoals foto's en film kunnen zijn.
  • Besluiten - voor de registratie van besluiten die in het kader van zaakgericht werken worden genomen.
  • Klantinteracties - deze API ondersteunt de registratie van Contactmomenten en Verzoeken. Verzoeken hebben een relatie met producten en diensten uit de Producten Diensten Catalogus (PDC) en kunnen leiden tot zaken. Deze API wordt op een later moment toegevoegd aan Open Zaak.

Daarnaast zijn er een paar generieke API's die nodig om gebruik te maken van deze API's:

  • Notificaties - in Common Ground worden gegevens bij de bron geregistreerd en bijgehouden. Consumers krijgen niet vanzelf bericht als er iets is gewijzigd. Hiervoor kunnen ze een abonnement registreren bij de Notificaties API.
  • Autorisaties - via de Autorisaties API wordt de toegang van applicaties tot gegevens geregeld.

Productiewaardige API's

Bij de realisatie van productiewaardige API's is aandacht besteed aan een aantal belangrijke aspecten:

  • Beheer: er is een beheerportaal ingericht waarmee de verschillende API's door functioneel beheerders kunnen worden beheerd.
  • Performance: er zijn performance-metingen verricht op basis van schattingen van de verwachte belasting door applicaties die eindgebruikers gebruiken. Benodigde verbeteringen zijn doorgevoerd waardoor een belasting door 2000 eindgebruikers geen problemen zou moeten opleveren.
  • Documentatie van de componenten, met name van de beheer applicaties. (De inhoudelijke documentatie over de API's is onderdeel van de standaard.)
  • Uitrol: Om de uitrol naar servers te vereenvoudigen is er een Docker container beschikbaar. Dit zijn een soort componenten die gemakkelijk kunnen worden uitgerold op een server om ze vervolgens in gebruik te nemen. Hiermee kunnen gemeenten de API’s op eenvoudige wijze (laten) draaien bij een hostingpartij.

Architectuur van Open Zaak

De architectuur van Open Zaak is gebaseerd op een beperkt aantal componenten. De belangrijkste component is de registratiecomponent die de API's voor ZGW aanbiedt. Daarnaast zijn er de volgende componenten:

  • Notificatie-component, noodzakelijk voor de werking van Open Zaak.
  • Selectielijst component die wordt gebruikt om de VNG Selectielijst voor archiveren te ontsluiten
  • Beheerportaal dat toegang biedt tot de verschillende beheerapps die bij de API's horen

Open-Zaak Componenten-overzicht

Implementatie

Deze repository bevat de broncode voor de API's. Om gebruik te kunnen maken van de API's moeten deze ergens gehost worden als een service. Als onderdeel van de ontwikkelstraat worden bij elke nieuwe versie van Open Zaak een Docker container die direct kunnen worden uitgerold in een Kubernetes cluster.

Links

Bouw

Deze API's zijn ontwikkeld door Maykin Media B.V. in opdracht van Amsterdam, Rotterdam, Utrecht, Tilburg, Arnhem, Haarlem, 's-Hertogenbosch, Delft en een coalitie van Hoorn, Medemblik, Stede Broec, Drechteland, Enkhuizen (SED), onder regie van Dimpact.

Licentie

Licensed under the EUPL

You can’t perform that action at this time.