========== Open Klant

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

|docs| |docker|

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 <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/master/src/openklant/components/klantinteracties/openapi.yaml>, Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/master/src/openklant/components/klantinteracties/openapi.yaml>, (diff <https://github.com/maykinmedia/open-klant/compare/2.3.0..master#diff-0198a3368d5c8c5325ef11e3c0ba8d2986f50b964c8002d3ece7cadc0b8ba23d>) 2.3.0 0.0.3+ 2024-09-05 ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.3.0/src/openklant/components/klantinteracties/openapi.yaml>, Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.3.0/src/openklant/components/klantinteracties/openapi.yaml>, (diff <https://github.com/maykinmedia/open-klant/compare/2.1.0..2.3.0#diff-0198a3368d5c8c5325ef11e3c0ba8d2986f50b964c8002d3ece7cadc0b8ba23d>) 2.1.0 0.0.3+ 2024-07-16 ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.1.0/src/openklant/components/klantinteracties/openapi.yaml>, Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.1.0/src/openklant/components/klantinteracties/openapi.yaml>, (diff <https://github.com/maykinmedia/open-klant/compare/2.0.0..2.1.0#diff-0198a3368d5c8c5325ef11e3c0ba8d2986f50b964c8002d3ece7cadc0b8ba23d>) 2.0.0 0.0.3 2024-03-15 ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.0.0/src/openklant/components/klantinteracties/openapi.yaml>, Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.0.0/src/openklant/components/klantinteracties/openapi.yaml> 1.0.0 0.0.1 2023-08-05 Klanten: ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/1.0.0/src/openklant/components/klanten/openapi.yaml>, Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/1.0.0/src/openklant/components/klanten/openapi.yaml> Contactmomenten: ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/1.0.0/src/openklant/components/contactmomenten/openapi.yaml>, Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/1.0.0/src/openklant/components/contactmomenten/openapi.yaml>_ ================== ============== ============= ================

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 <https://github.com/maykinmedia/open-klant/blob/master/CHANGELOG.rst>_

Ready-to-go implementatie

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

Download en start Open Klant:

.. code:: bash

$ 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
In de browser, navigeer naar http://localhost:8000/ om de beheerinterface en de API te benaderen.