Op /api staat een interactief overzicht van Statusgegevens en Zoekresultaten, opgebouwd met Swagger UI over een OpenAPI-specificatie. Een bezoeker leest er per adres welke parameters het kent en wat het teruggeeft, en kan een aanroep rechtstreeks vanuit de pagina uitproberen, zonder een eigen programma te schrijven.
Downloaden
De specificatie staat op twee adressen, /api/openapi.json en /api/openapi.yaml, allebei in de vorm die het OpenAPI-formaat voorschrijft. Bovenaan de pagina staat voor elk een knop. Wie liever een eigen client genereert dan de interactieve pagina gebruikt, downloadt een van beide en voert het in het eigen gereedschap in.
De pagina zelf
De pagina draagt het logo van BesluitBron, een verwijzing terug naar de site en de taal van de bezoeker, net als de rest van de site. De twee knoppen voor het downloaden volgen dezelfde opmaak als een knop elders op de site. Wat Swagger UI zelf tekent, de balk met "Explore" en de tekst van elke knop daaronder, blijft Engels: dat deel komt van het gereedschap zelf en wordt niet vertaald.
Het adres staat ook in de voettekst van elke pagina, onder "Bronnen", naast "Gezondheid".
Wat er niet in staat
Het overzicht beperkt zich tot de twee adressen onder /api. De verkenners van de beheerconsole en de exports van het zoekscherm zijn geen gepubliceerd programma-adres en staan daarom niet in deze specificatie, zie Verkenner.
Op een installatie die niet Production heet, komen daar de vijf adressen van de zelfregistratiekoppeling voor automatisering bij (/api/automation/...). Die koppeling werkt alleen wanneer een sleutel is ingesteld, zie Installatie; zonder die sleutel beantwoordt elk van de vijf adressen elke aanroep hetzelfde, alsof het adres niet bestaat.