Unter /api finden Sie eine interaktive Übersicht über Statusgegevens und Zoekresultaten, die mit Swagger UI auf Basis einer OpenAPI-Spezifikation erstellt wurde. Dort kann ein Besucher für jede Adresse nachlesen, welche Parameter sie akzeptiert und welche Ergebnisse sie zurückgibt, und einen Aufruf direkt von der Seite aus testen, ohne ein eigenes Programm schreiben zu müssen.
Herunterladen
Die Spezifikation ist unter zwei Adressen verfügbar: /api/openapi.json und /api/openapi.yaml, beide in der vom OpenAPI-Format vorgeschriebenen Form. Oben auf der Seite befindet sich jeweils eine Schaltfläche. Wer lieber einen eigenen Client generieren möchte, anstatt die interaktive Seite zu nutzen, kann eine der beiden Dateien herunterladen und in sein eigenes Tool einbinden.
Die Seite selbst
Die Seite trägt das Logo von BesluitBron, einen Link zurück zur Website und die Sprache des Besuchers, genau wie der Rest der Website. Die beiden Schaltflächen zum Herunterladen folgen dem gleichen Layout wie eine Schaltfläche an anderer Stelle auf der Website. Was Swagger UI selbst anzeigt – die Leiste mit „Explore“ und der Text der einzelnen Schaltflächen darunter – bleibt auf Englisch: Dieser Teil stammt aus dem Tool selbst und wird nicht übersetzt.
Die Adresse ist auch in der Fußzeile jeder Seite unter „Quellen“ neben „Gesundheit“ zu finden.
Was nicht darin steht
Die Übersicht beschränkt sich auf die beiden Adressen unter /api. Die Explorer der Verwaltungskonsole und die Exporte des Suchbildschirms sind keine veröffentlichten Programmadressen und sind daher nicht in dieser Spezifikation enthalten, siehe Verkenner.
Bei einer Installation, die nicht „Production“ heißt, kommen noch die fünf Adressen des Selbstregistrierungs-Links für die Automatisierung hinzu (/api/automation/...). Dieser Link funktioniert nur, wenn ein Schlüssel eingerichtet wurde, siehe Installatie; ohne diesen Schlüssel antwortet jede der fünf Adressen auf jeden Aufruf mit derselben Antwort, als ob die Adresse nicht existieren würde.