Wijziging in URL’s van REST-services

Gepubliceerd 15 april 2022

De URL’s van onze publieke REST-services zijn veranderd. We volgen daarmee  de afspraken van de Nederlandse overheid, die zijn vastgelegd in de REST designrules. Vanaf nu zijn de oude URL’s niet meer actief en kun je alleen de nieuwe URL’s gebruiken.

Wij hebben enige tijd geleden aangekondigd dat de URL’s van onze publieke REST-services de afspraken gaan volgen in REST Designrules van de NL overheid. Dit hebben wij ook toegelicht op onze pagina’s op de BRO Productomgeving. Om te voorkomen dat dit tot problemen zou leiden hebben we de oude URL’s nog een aantal maanden actief gehouden. Vanaf nu zijn de oude URL’s niet meer actief. Dit doen we om verder gebruik te vermijden en onze te onderhouden instellingen/configuratie zo minimaal mogelijk te houden.

Voorbeelden:

Nieuwe stijl URL: https://publiek.broservices.nl/gm/gmw/v1/
Oude stijl URL: https://publiek.broservices.nl/gm/gmw-v1.1

Technische achtergrond

Versienummers in de BRO zijn opgebouwd volgens semantic versioning: major.minor.patch. Zowel de major als de minor versie waren zichtbaar in de URL. De REST designrules schrijven voor dat alleen het major versie nummer aanwezig moet zijn in de URL. De volledige versie (major.minor.patch) komt onder water terug als header ‘API-Version’ in het HTTP-antwoord en is ook zichtbaar voor de gebruiker op de index pagina: https://publiek.broservices.nl/gm/gmw/v1/.