Onderwijsloket API: data van en vóór alle onderwijsorganisaties

Via de API stellen we de informatie en data van het Onderwijsloket beschikbaar voor partners in het onderwijsveld. Denk aan regionale loketten, opleiders, overheden of platforms die mensen helpen bij hun oriëntatie op een carrière in het onderwijs.

Het idee daarachter is eenvoudig: de informatie die wij verzamelen en onderhouden is waardevol voor het hele ecosysteem. Door deze data via een API beschikbaar te maken, kunnen organisaties deze informatie eenvoudig integreren in hun eigen websites, tools of applicaties.

Zo zorgen we ervoor dat actuele, onafhankelijke informatie over werken in het onderwijs op steeds meer plekken beschikbaar komt.

Wat is de Onderwijsloket API?

Een API (Application Programming Interface) is een technische interface waarmee systemen met elkaar kunnen communiceren. In dit geval betekent het dat andere organisaties rechtstreeks toegang kunnen krijgen tot de informatie die het Onderwijsloket verzamelt en onderhoudt.

Die informatie wordt centraal beheerd in onze database en vervolgens via de API beschikbaar gesteld. Ontwikkelaars kunnen deze gegevens ophalen en verwerken in hun eigen toepassingen.

Denk bijvoorbeeld aan:

• het tonen van artikelen of veelgestelde vragen over werken in het onderwijs

• het integreren van opleidingsinformatie in een regionale website

• het bouwen van een zoekfunctie voor onderwijsroutes

• het tonen van regionale onderwijsloketten op basis van locatie

• het laten plannen van een adviesgesprek via het Onderwijsloket

Het grote voordeel: informatie hoeft niet op meerdere plekken handmatig te worden bijgehouden. Updates die bij het Onderwijsloket worden doorgevoerd, worden automatisch zichtbaar in alle systemen die gebruikmaken van de API.

Wat kun je ermee bouwen?

De mogelijkheden van de API zijn breed. Partners kunnen het API platform van het Onderwijsloket bijvoorbeeld gebruiken om:

1. Kennis en informatie te ontsluiten: Organisaties kunnen artikelen, FAQ’s of achtergrondinformatie integreren in hun eigen platform, bijvoorbeeld rondom bevoegdheden, opleidingen of subsidies.

2. Opleidingen en onderwijsinstellingen vindbaar te maken: Via de API kunnen gegevens over opleidingen, onderwijsinstellingen en locaties worden opgehaald en verwerkt in bijvoorbeeld studiezoekers of regiogidsen.

3. Routes naar het onderwijs zichtbaar te maken: Het Onderwijsloket bevat duizenden mogelijke routes naar een functie in het onderwijs. Deze routes kunnen – afhankelijk van iemands achtergrond en ambities – worden gefilterd en gepresenteerd in andere platforms.

4. Zoekfunctionaliteit te integreren Onze zoekmachine maakt het mogelijk om razendsnel door verschillende soorten informatie te zoeken, zoals artikelen, opleidingen en mediacontent.

5. Een adviesgesprek met het Onderwijsloket te plannen: Partners kunnen de afsprakenplanner van het Onderwijsloket rechtstreeks in hun eigen website integreren, zodat bezoekers eenvoudig een adviesgesprek kunnen inplannen.

6. Media content van het Onderwijsloket integreren: van ervaringsverhalen in blogvorm, tot aan de meest recente aflevering van een van de podcastseries van het Onderwijsloket. Alle informatie over media items (en óók de media zelf) is opvraagbaar via de API.

Op die manier kan de informatie van het Onderwijsloket naadloos onderdeel worden van de digitale dienstverlening van andere organisaties.

De bouwstenen van ons API-platform

Om dit mogelijk te maken bestaat het API-platform van het Onderwijsloket uit verschillende onderdelen. Samen vormen deze de technische infrastructuur waarmee partners onze data kunnen gebruiken.

Content API

De Content API vormt de kern van het platform. Hierin staat alle gestructureerde informatie van het Onderwijsloket opgeslagen.

Via deze API kunnen ontwikkelaars onder andere informatie ophalen over:

• kennisbankartikelen en veelgestelde vragen

• opleidingen en onderwijsinstellingen

• regionale onderwijsloketten

• routes naar het onderwijs

• media zoals podcasts, video’s en ervaringsverhalen

De API is gebouwd op het open-sourceplatform Directus en biedt flexibele mogelijkheden om data te filteren, combineren en doorzoeken.

Search Engine

Naast de Content API bieden we ook toegang tot onze zoekmachine.

Deze zoeklaag wordt aangedreven door het searchplatform Algolia en maakt het mogelijk om razendsnel door verschillende soorten informatie te zoeken. Ontwikkelaars kunnen hiermee bijvoorbeeld:

• een centrale zoekbalk bouwen

• resultaten filteren op onderwerpen of sectoren

• zoeken binnen meerdere datasets tegelijk

Zo kan bijvoorbeeld één zoekopdracht tegelijk resultaten opleveren uit artikelen, opleidingen, FAQ’s en podcasts.

Asset delivery (media)

Alle afbeeldingen, video’s, audiofragmenten en documenten van het Onderwijsloket worden via een aparte media-infrastructuur geleverd.

Deze assets zijn publiek toegankelijk en kunnen eenvoudig worden geïntegreerd in andere websites. Het platform ondersteunt automatische optimalisatie en verschillende mediaformaten, zodat bestanden snel en efficiënt kunnen worden geladen.

Afsprakenplanner

Partners kunnen ook de afsprakenplanner van het Onderwijsloket integreren in hun eigen website.

Hiermee kunnen bezoekers direct een adviesgesprek plannen met een adviseur van het landelijke Onderwijsloket, zonder de website van de partner te verlaten. Dit helpt organisaties om geïnteresseerden snel en eenvoudig door te verwijzen naar onafhankelijk advies.

Documentatie en ontwikkeltools

Om het gebruik van de API zo toegankelijk mogelijk te maken, hebben we verschillende hulpmiddelen ontwikkeld voor ontwikkelaars.

API-documentatie

Op ons documentatieplatform staat uitgebreide uitleg over het gebruik van de API, het datamodel en integratiemogelijkheden.

API Explorer

Met de interactieve API Explorer kunnen ontwikkelaars endpoints verkennen en direct testen welke data beschikbaar is.

Example repository

Op GitHub publiceren we voorbeeldcode en praktische integraties, zodat ontwikkelaars snel kunnen zien hoe ze met de API kunnen werken.

Statuspagina

Via onze statuspagina houden we partners op de hoogte van de beschikbaarheid en prestaties van het platform.

Aan de slag

Ben je benieuwd wat er mogelijk is of wil je verkennen hoe de API in jouw organisatie gebruikt kan worden? Neem gerust een kijkje in de documentatie, vraag je API key aan, of neem contact met ons op – we denken graag mee over de mogelijkheden voor jouw organisatie.