Getting Started

De ‘WOZ Bevragen’ API is gespecificeerd met behulp van de OpenAPI Specifications (OAS3).

Om aan te sluiten kun je de volgende stappen doorlopen:

  1. Bekijk de functionaliteit en specificaties
  2. Implementeer de API
  3. Probeer en test de API

Functionaliteit en specificaties

Je kunt een visuele representatie van de specificatie bekijken met Swagger UI of Redoc.

Bouw de API

We hebben client code voor API-clients in enkele varianten. Hiermee kan je direct aan de slag met het gebruiken van de API.

Zit jouw gewenste ontwikkelomgeving er niet bij, dan kan je zelf ook code genereren vanuit de “genereervariant” van de API-specificaties.

Probeer en test de API

Om te testen heb je een API-key nodig. Deze plaats je in requests in de header “x-api-key”.

De url van de testomgeving is https://api.acceptatie.kadaster.nl/lvwoz/api/v1.

Bijvoorbeeld (met een fictieve API-key): curl –location –request GET ‘https://api.acceptatie.kadaster.nl/lvwoz/api/v1/wozobjecten/800000093455’ –header ‘x-api-key: a123bcd456efg789hij0’

Er is een aantal testgevallen beschikbaar in de acceptatieomgeving. Een overzicht van de testgevallen vind je in test/cases.