| Version: | 2.4.0 |
|---|---|
| Source: | https://github.com/maykinmedia/open-klant |
| Keywords: | klanten, klantinteracties, contactmomenten, api, common ground |
| License: | EUPL |
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.
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.
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.4.0 | 0.0.3+ | 2024-11-22 |
(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
Bovenstaand informatiemodel is opgesteld met de volgende opmerkingen:
- Voor de leesbaarheid en onderhoudbaarheid bevat het SIM niet de attributen zoals in het oorspronkelijke model. Deze zijn niet belangrijk voor het begrip van het model en eenvoudig op te zoeken in de API-specificatie.
- Voor de relaties tussen entiteiten worden de feitelijke attribuutnamen uit de API specificatie gebruikt met weglating van de entiteit waarnaar wordt verwezen, bijv. "leiddeTotInterneTaken" word "leidde tot".Dit verbetert de de relatie met de API en daarmee het begrip. Als er geen betekenisvolle attribuutnaam voor de relatie wordt gebruikt (bijv. alleen de naam van de gerelateerde entiteit), is de relatienaam leeg gelaten.
- Alle relaties tussen entiteiten worden gevisualiseerd. Soms zijn er relaties in beide richtingen.
- De meeste API resources worden gevisualiseerd als een entiteit in het model. Actor Klantcontacten is weggelaten omdat dit een linktabel is.
- Het kader “OpenKlant begrenzing“ geeft aan welke entiteiten in het register kunnen worden beheerd. De geel gekleurde entiteiten staan in een extern register. Om naar deze externe entiteiten te verwijzen wordt gebruik gemaakt van zgn. identificatoren.
- Cardinaliteit is met * aangegeven als er meer dan één entiteit gekoppeld kan worden.
- Bij Actor en Partij is class inheritance gebruikt om specieke actoren c.q. partijen te modelleren. Dit is in de API uitgewerkt met een attribuut soortActor en soortPartij die de specialisatie uitdrukt.
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.
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
In de browser, navigeer naar
http://localhost:8000/om de beheerinterface en de API te benaderen.
Copyright © Maykin B.V., 2023 - 2024
Licensed under the EUPL