Startgids - Werken met de Onderwijsloket API (1/4)
In deze serie artikelen laten we zien hoe ontwikkelaars met de Onderwijsloket API kunnen werken. Niet door de volledige documentatie te herhalen, maar door het platform en de mogelijkheden ervan op hoofdlijnen te verkennen.
We beginnen bij het begin: hoe werkt het platform eigenlijk, en hoe haal je er data uit?
De bouwstenen van het Onderwijsloket-platform
Het platform van het Onderwijsloket bestaat uit een aantal lagen die elk een eigen rol hebben. Samen zorgen ze ervoor dat informatie kan worden beheerd, doorzocht en geïntegreerd in andere toepassingen.
Je kunt het platform zien als vijf bouwstenen.
1. De databron
Alle informatie van het Onderwijsloket wordt centraal opgeslagen in één gestructureerde database. Hier staan onder andere:
kennisbankartikelen en FAQ’s
opleidingen en onderwijsinstellingen
regionale onderwijsloketten
routes naar het onderwijs
mediacontent zoals podcasts en video’s
Deze data worden beheerd en onderhouden door het redactie- en adviseursteam van het Onderwijsloket, is altijd actueel, correct en onafhankelijk.
2. De Content API
Via de Content API kunnen ontwikkelaars deze data rechtstreeks ophalen.
Dit gebruik je wanneer je specifieke informatie nodig hebt, zoals een artikel uit de kennisbank, een lijst met opleidingen of informatie over een onderwijsinstelling. De API maakt het mogelijk om data te filteren, combineren en uitbreiden met gerelateerde informatie.
De Content API van het Onderwijsloket is gebouwd op het open-sourceplatform Directus.
3. De Search Engine
Naast de Content API is er een aparte zoeklaag. Deze wordt aangedreven door Algolia en maakt het mogelijk om razendsnel door grote hoeveelheden informatie te zoeken.
Deze laag is bedoeld voor toepassingen zoals zoekbalken, filters en navigatieinterfaces. Een zoekopdracht kan bijvoorbeeld tegelijk resultaten opleveren uit artikelen, opleidingen, FAQ’s en mediacontent.
4. Asset delivery (media)
Alle afbeeldingen, video’s, audiofragmenten en documenten van het Onderwijsloket worden via een aparte media-infrastructuur geleverd.
Deze assets worden gehost en gedistribueerd via Cloudinary. Hierdoor kunnen media automatisch worden geoptimaliseerd en snel worden geladen via een wereldwijd CDN.
5. Applicaties en websites
De data uit deze lagen kunnen vervolgens worden gebruikt in verschillende toepassingen, zoals:
de website van het Onderwijsloket
websites van regionale loketten
studie- en opleidingsnavigators
platforms van onderwijsinstellingen
andere tools binnen het onderwijsdomein
Zo kan dezelfde informatie op meerdere plekken worden gebruikt, terwijl de inhoud centraal beheerd blijft.
Content API of Search Engine?
Aangezien beide lagen overlappende data bevatten is het een relevante vraag om te stellen: wanneer gebruik je de Content API en wanneer de Search Engine?
De Content API gebruik je wanneer je specifieke data wilt ophalen. Bijvoorbeeld wanneer je een artikel wilt tonen, een lijst van opleidingen wilt ophalen of informatie over een onderwijsinstelling nodig hebt.
De Search Engine gebruik je wanneer gebruikers door grote hoeveelheden informatie moeten zoeken. Denk aan een zoekbalk, filters op onderwerpen of een navigator met resultaten op basis van locatie of interesse.
In de praktijk worden beide lagen vaak gecombineerd. Een zoekopdracht levert bijvoorbeeld een lijst met relevante resultaten op, waarna de applicatie via de Content API de volledige informatie van een geselecteerd item ophaalt.
Wat kun je bouwen met de Onderwijsloket API?
Partners gebruiken de API op verschillende manieren om informatie over werken in het onderwijs toegankelijk te maken.
het integreren van specifieke artikelen en FAQ’s in een eigen kennisbank
het tonen van opleidingen en onderwijsinstellingen binnen een specifieke regio
het tonen van regionale onderwijsloketten op basis van locatie
Het gebruik van onze meta data en taxonomieën in de eigen gegevensverwerking
Omdat de data centraal wordt beheerd door het Onderwijsloket, blijven deze toepassingen automatisch up-to-date wanneer informatie wordt aangepast.
Aan de slag
Wil je zelf met de Onderwijsloket API werken? In onze developer documentatie vind je uitgebreide uitleg over het gebruik van de API, het datamodel en de beschikbare datasets.
Daar kun je ook:
de interactieve API Explorer gebruiken om datasets te verkennen
praktische integratievoorbeelden bekijken
codevoorbeelden vinden in onze example repository
In de volgende artikelen
In de volgende artikelen uit deze serie duiken we dieper in het platform en laten we zien hoe je het in de praktijk kunt gebruiken.
(2/4) Het datamodel van het Onderwijsloket begrijpen: hoe zijn de verschillende datasets opgebouwd en met elkaar verbonden?
(3/4) Zoeken in het Onderwijsloket: hoe bouw je een snelle zoekervaring met de search engine?
(4/4) Bij jou in de buurt: hoe je komt tot een voor de gebruiker (geografisch) relevante selectie van opleidingen en regionale onderwijsloketten
