API versies

Zaken API Documenten API Besluiten API Catalogi API Autorisaties API Notificaties API

Algemeen

Een API versie wordt als volgt aangeduid: <major>.<minor>.<patch>. Hierbij geldt dat:

  • Major - Een major versie update (bijv. van 1.x naar 2.x) bevat breaking changes t.o.v. de vorige major versie.
  • Minor - Een minor versie update (bijv. van 1.0.x naar 1.1.x) bevat inhoudelijke wijzigingen aan de API die geen breaking changes betreffen.
  • Patch - Een patch versie update (bijv. van 1.0.0 naar 1.0.1) bevat geen inhoudelijke wijzigingen maar slechts documentatie of soepelere validatie regels.

Elke major API versie krijgt minimaal 1 jaar ondersteuning vanaf de release datum van de volgende major API versie.

Er wordt maximaal 1 major versie per jaar gepubliceerd.

Er worden minimaal 2 major versies onderhouden middels updates. Dit betekent dat er voor deze versies gelijktijdig minor en patch updates worden uitgebracht.

Opmerking: Er kunnen “tags” bestaan zoals x.y.z.post0. Dit zijn verbeteringen in de referentie implementatie en betreffen nooit een gewijzigde API specificatie t.o.v. x.y.z.

Zaken API

Ondersteuning

Versie Release datum Einddatum ondersteuning Documentatie
1.x 2019-11-18 (nog niet bekend) Documentatie

Releases

Versie Release datum API specificatie
1.0.2 2020-06-12 ReDoc, Swagger, Diff
1.0.1 2019-12-16 ReDoc, Swagger, Diff
1.0.0 2019-11-18 ReDoc, Swagger

Documenten API

Ondersteuning

Versie Release datum Einddatum ondersteuning Documentatie
1.x 2019-11-18 (nog niet bekend) Documentatie

Releases

Versie Release datum API specificatie
1.0.1 2019-12-16 ReDoc, Swagger, Diff
1.0.0 2019-11-18 ReDoc, Swagger

Besluiten API

Ondersteuning

Versie Release datum Einddatum ondersteuning Documentatie
1.x 2019-11-18 (nog niet bekend) Documentatie

Releases

Versie Release datum API specificatie
1.0.1 2019-12-16 ReDoc, Swagger, Diff
1.0.0 2019-11-18 ReDoc, Swagger

Catalogi API

Ondersteuning

Versie Release datum Einddatum ondersteuning Documentatie
1.x 2019-11-18 (nog niet bekend) Documentatie

Releases

Versie Release datum API specificatie
1.0.0 2019-11-18 ReDoc, Swagger

Autorisaties API

Ondersteuning

Versie Release datum Einddatum ondersteuning Documentatie
1.x 2019-11-18 (nog niet bekend) Documentatie

Releases

Versie Release datum API specificatie
1.0.0 2019-11-18 ReDoc, Swagger

Notificaties API

Ondersteuning

Versie Release datum Einddatum ondersteuning Documentatie
1.x 2019-11-18 (nog niet bekend) Documentatie

Releases

Versie Release datum API specificatie
1.0.0 2019-11-18 ReDoc, Swagger