At /api ] there is an interactive overview of Statusgegevens and Zoekresultaten, built using Swagger UI based on an OpenAPI specification. Visitors can see, for each endpoint, which parameters it accepts and what it returns, and can test a request directly from the page without having to write their own programme.
Download
The specification is available at two addresses, /api/openapi.json and /api/openapi.yaml, both in the format prescribed by OpenAPI. There is a button at the top of each page. Anyone who would prefer to generate their own client rather than use the interactive page can download one of the two and integrate it into their own tool.
The page itself
The page features the BesluitBron logo, a link back to the site and the visitor’s language, just like the rest of the site. The two download buttons follow the same layout as buttons elsewhere on the site. The elements generated by Swagger UI itself – the bar with ‘Explore’ and the text on each button below it – remain in English: this part comes from the tool itself and is not translated.
The address also appears in the footer of every page, under ‘Sources’, next to ‘Health’.
What isn’t included
This overview is limited to the two addresses listed at /api. The management console explorers and the search screen exports are not published programme addresses and are therefore not included in this specification; see Verkenner.
On an installation that is not named ‘Production’, the five addresses for the self-registration link for automation are added (/api/automation/...). This link only works when a key has been set; see Installatie. Without that key, each of the five addresses responds to every request in the same way, as if the address did not exist.