Version: | 0.2.0 |
---|---|
Source: | https://github.com/maykinmedia/referentielijsten |
Keywords: | referentielijsten, stamtabellen |
The Referentielijsten API (Reference lists API) is a generic API for simple and reusable data lists (Nederlandse versie)
Developed and financed by Maykin B.V..
There are currently 3 initiatives for reference lists. In the VNG API standard for Zaakgericht Werken there is a variant that was never formalized. The VNG initiative for Klantinteracties API also includes a variant that differs slightly and has not been formally acknowledged. Finally, there is also the Objects API that is sometimes used for this purpose. However, it cannot enforce uniqueness of items in the list and offers too much freedom in attributes.
That is why a generic approach for reference lists was chosen, which deserves its own API. The API is intended as a registration of reusable data lists where the values of these lists may be stored in others registrations. This prevents unnecessary calls to this API for just one textual value.
Version | Release date | API specification |
---|---|---|
latest | n/a | ReDoc, Swagger, (diff) |
0.1.0 | 2024-05-28 | ReDoc, Swagger |
Previous versions are supported for 6 month after the next version is released.
This repository contains the source code for Referentielijsten API. To quickly get started, we recommend using the Docker image. You can also build the project from the source code. For this, please look at INSTALL.rst.
Download and run Referentielijsten API:
$ wget https://raw.githubusercontent.com/maykinmedia/referentielijsten/master/docker-compose.yml $ docker-compose up -d --no-build $ docker-compose exec web src/manage.py loaddata demodata $ docker-compose exec web src/manage.py createsuperuser
In the browser, navigate to
http://localhost:8000/
to access the admin and the API.
Copyright © Maykin 2024
Licensed under the EUPL