Naar hoofdinhoud

API opzet

Technische opzet

Je kunt de data op twee manieren ophalen:

  • via een REST-API (in JSON-formaat);
  • via een download van de hele database in CSV, XLSX of JSON.

Over de API

De API is een REST API obv Forum Standaardisatie (REST-API Design Rules (Nederlandse API Strategie IIa) 1.0). Er is een OpenAPI-specificatie bechikbaar. Ook kun je de API testen via een online tool (Swagger). 

Het overkoepelende principe van de API is:

  • Alle velden in de API zijn optioneel, behalve velden die in het databaseschema een primary of foreign key zijn;
  • Een niet gevuld veld is niet zichtbaar in de API;
  • Eenmaal aangemaakte velden en tabellen mogen nooit meer van type wijzigen (maar de data kan dus wel worden weggelaten).