Skip to content

Latest commit

 

History

History
159 lines (115 loc) · 9.48 KB

README.NL.rst

File metadata and controls

159 lines (115 loc) · 9.48 KB

Objecten API

Version: 2.2.0
Source:https://github.com/maykinmedia/objecttypes-api
Keywords:objecten, assets, zaakobjecten

Documentation Status

API om objecten te beheren die behoren bij een bepaald objecttype. (English version)

Ontwikkeld door Maykin Media B.V. in opdracht van de gemeente Utrecht.

Introductie

De Objecten API heeft als doel om uiteenlopende objecten eenvoudig te kunnen registreren en ontsluiten in een gestandaardiseerd formaat. De Objecten API kan door elke organisatie ingezet worden om de voor haar interessante objecten te beheren. Ook kan een organisatie er voor kiezen een Objecten API in te zetten voor Open Data, waarbij de geregistreerde objecten publiekelijk toegankelijk zijn.

Om het formaat van objecten, de zogenoemde objecttypen, vast te leggen wordt gebruik gemaakt van de landelijke en/of een lokale Objecttypen API.

API specificatie

Lint OAS Generate SDKs Generate Postman collection

Versie Release datum API specificatie
latest n/a ReDoc, Swagger, (verschillen)
2.2.0 2024-01-30 ReDoc, Swagger (verschillen)
2.1.0 2022-06-24 ReDoc, Swagger (verschillen)
2.1.0 2022-05-17 ReDoc, Swagger (verschillen)
2.0.0 2021-09-22 ReDoc, Swagger (verschillen)
1.3.0 2021-01-12 ReDoc, Swagger (verschillen)
1.2.0 2021-09-22 ReDoc, Swagger (verschillen)
1.1.1 2021-06-22 ReDoc, Swagger (verschillen)
1.1.0 2021-04-21 ReDoc, Swagger (verschillen)
1.0.0 2021-01-13 ReDoc, Swagger

Vorige versies worden nog 6 maanden ondersteund nadat de volgende versie is uitgebracht.

Zie: Alle versies en wijzigingen

Referentie implementatie

Build status Coverage Code style Docker image Supported Python version

De referentie implementatie toont de API in actie en kan gebruikt worden voor test en demonstratie doeleinden. De referentie implementatie is open source, goed getest en beschikbaar als Docker image.

Quickstart

  1. Download en start de Objecten API:

    $ wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose-quickstart.yml -O docker-compose.yml
    $ docker-compose -f docker-compose-qs.yml up -d
    $ docker-compose exec web src/manage.py loaddata demodata
    $ docker-compose exec web src/manage.py createsuperuser
  2. In de browser, navigeer naar http://localhost:8000/ om de admin en de API te benaderen.

Links

Licentie

Copyright © Maykin Media, 2020 - 2021

Licensed under the EUPL