Skip to content

Latest commit

 

History

History
161 lines (113 loc) · 8.43 KB

README.rst

File metadata and controls

161 lines (113 loc) · 8.43 KB

Open Klant

Version: 2.3.0
Source:https://github.com/maykinmedia/open-klant
Keywords:klanten, klantinteracties, contactmomenten, api, common ground
License:EUPL

Documentation Status Docker image

Registratiecomponent voor de opslag en ontsluiting van klantgegevens volgens de Klantinteracties API-specificatie. (English version)

Ontwikkeld door Maykin B.V. in samenwerking met gemeente Amsterdam, gemeente Den Haag, gemeente Utrecht en VNG Realisatie.

Introductie

Open Klant implementeert de (concept) Klantinteracties API specificatie van VNG welke een beperkte set aan gegevens over klanten en hun interactie met de gemeente kan opslaan en ontsluiten.

Samen met gemeenten, die volop bezig zijn met de implementatie van Common Ground, en VNG, wordt gewerkt aan standaardisatie van de API en realisatie van Open Klant als beproeving van de toekomstige API standaard.

API specificatie

Hieronder staat de versie van Open Klant en welke versie van de API-specificatie wordt aangeboden.

Open Klant versie API versie Release datum API specificatie
master/latest n/a n/a ReDoc, Swagger, (diff)
2.3.0 0.0.3+ 2024-09-05 ReDoc, Swagger, (diff)
2.1.0 0.0.3+ 2024-07-16 ReDoc, Swagger, (diff)
2.0.0 0.0.3 2024-03-15 ReDoc, Swagger
1.0.0 0.0.1 2023-08-05 Klanten: ReDoc, Swagger Contactmomenten: ReDoc, Swagger

Vorige versies worden nog 6 maanden ondersteund nadat de volgende versie is uitgebracht. Open Klant versie 1.0.0 bevat nog de Klanten en Contactmomenten API-specificatie die door VNG is geschrapt en beschouwd moet worden als legacy.

Zie: Alle versies en wijzigingen

Ready-to-go implementatie

Build status Coverage Code style CodeQL scan Code style Supported Python version

Deze implementatie is bedoeld als referentie implementatie van de API specificaties maar tevens een productiewaardig component dat ingezet kan worden in het ICT landschap van de overheid.

Quickstart

  1. Download en start Open Klant:

    $ wget https://raw.githubusercontent.com/maykinmedia/open-klant/master/docker-compose.yml
    $ docker-compose up -d --no-build
    $ docker-compose exec web src/manage.py loaddata klantinteracties contactgegevens
    $ docker-compose exec web src/manage.py createsuperuser
  2. In de browser, navigeer naar http://localhost:8000/ om de beheerinterface en de API te benaderen.

Links

Licentie

Copyright © Maykin B.V., 2023 - 2024

Licensed under the EUPL