Referentie-implementatie

De referentie-implementatie van de Open Onderwijs API is te bekijken op: http://api.openonderwijsapi.nl/

Open Onderwijs API referentie implementatie

Open Onderwijs API referentie implementatie

Voor deze referentie-implementatie is het Django REST framework gebruikt. Met deze krachtige toolkit is het mogelijk om de Open Onderwijs API inzichtelijk te maken doordat je ziet welke communicatie naar je browser wordt gestuurd. Vooral voor applicatie ontwikkelaars is dit een waardevolle tool, maar het geeft geïnteresseerden ook een goed beeld naar de mogelijkheden.

Een voorbeeld

Stel, je bent geïnteresseerd in de API aanroep ‘/persons’. De referentie-implementatie laat op http://api.openonderwijsapi.nl/v1/persons het volgende beeld zien met de default ‘OPTIONS’ request:

Django-persons-options

‘OPTIONS’ laat hier feitelijk de code zien van de aangeroepen API. Wanneer je nu op de ‘GET’ button rechtsboven klikt, dan zal je de JSON output zien van de aangeroepen API. In dit geval zie je hier de gegevens van de persoon met id=1:

Django-persons-get

Het is ook mogelijk om de output bijvoorbeeld in XML te tonen door een andere output optie te selecteren onder de ‘GET’ button.

Een applicatie ontwikkelaar is hiermee in staat om op basis van deze informatie een applicatie te ontwikkelen die deze XML of JSON output in een voor de gebruiker meer zinvolle verschijningsvorm aan kan bieden. Wij hebben hiervoor zelf ook een Open Onderwijs API demo applicatie ontwikkeld. Wanneer je hier op deze demo op de ‘Persons’ button klikt, dan zie je dezelfde persoonsgegevens in een webpagina te voorschijn komen.

demo-persons