Beschrijving

Open Education API (OEAPI) is de nieuwe, Engelstalige benaming van Open Onderwijs API, ook wel bekend onder de namen OOAPI en OO API. De OEAPI specificatie bestaat uit een aantal onderdelen: het generieke datamodel, beschrijvingen van verschillende endpoints waarlangs de omschreven data kan worden uitgewisseld en de te verwachten resultaten van deze uitwisseling zijn beschreven. Daarnaast is de specificatie verder aangevuld met een overzicht van best practices en implementatie informatie.

Het generieke datamodel is gericht op de uitwisseling van onderwijsinformatie (data in transit). Het datamodel is gestructureerd rondom vier data types:

1. De onderwijsspecificatie (welke het onderwijs op hoofdlijnen omschrijft en gebruikt wordt als template).
2. Het onderwijsaanbod (het onderwijs wat aangeboden wordt zowel op het gebied van samenstellingen van onderwijs eenheden als de kleinere elementen waarop een lerende zich in kan schrijven).
3. De inschrijvingen en resultaten (de werkelijke inschrijvingen van lerenden op het onderwijs aanbod aangevuld met de behaalde resultaten).
4. Generieke informatie die nodig is om de structuur van een onderwijs instelling weer te geven, persoonsgegevens uit te kunnen wisselen en lerenden in groepen in te kunnen delen

De specificatie is hierbij generiek opgezet voor een breed toepassingsgebruik en hergebruik van dezelfde specificatie voor een grote verscheidenheid aan integratiebehoeftes.

Naast de vaste schema’s, objecten en attributen is de OEAPI ook flexibel. Gebruikers kunnen voor eigen (niet generieke) use cases een uitbreiding definiëren met maatwerk attributen en/of endpoints.

Samenhang

Deze afspraak heeft een overlappend functionele toepassing met de Edu-V praktijksituaties “Toetsen en examineren” en “Doorgifte administratie”, deze overlap komt tezamen in het werkingsgebied mbo die eveneens bij Edu-V is betrokken.

De OEAPI v6 specificatie is afgestemd met het HORA 3.0 CGM, zie HORA. Er vindt afstemming van begrippen plaats met HORA en MORA.

Zowel de HOVI als de OEAPI hebben gegevens over instellingen. Het toepassingsgebied van HOVI gaat verder in op marketingdoeleinden, de OEAPI richt zich meer op informatievoorziening richting zittende studenten en medewerkers.

Meerwaarde

De meerwaarde van implementatie en ondersteuning van de standaard zit in het netwerkeffect: bij het opzetten van een koppeling tussen systemen (zowel buiten als binnen de eigen instelling) is het minder werk om een koppeling te realiseren en te onderhouden.

Daarnaast is het voordeel van een generieke standaard zoals de OEAPI dat deze standaard voor meerdere informatie-uitwisselingen hergebruikt kan worden.

Meer informatie staat op openonderwijsapi.nl.

Gebruik

De OEAPI v6 specificatie is uitvoerig beschreven, net als voorgaande versies. Alle informatie is online en publiek beschikbaar. Dit betreft onder andere documentatie over het datamodel, de endpoints en de data-elementen.

Het is voor eenieder mogelijk om de specificaties, inclusief alle bijbehorende documentatie, te gebruiken, te kopiëren en te (her)gebruiken om niet.  Er is sprake van European Union Public License (EUPL) 1.2 (gepland vanaf 1 maart 2026).

De ontwikkeling van de OEAPI is beïnvloed door bestaande normen en voorschriften op basis van de Nederlandse “pas toe of leg uit”-lijst. En bij de ontwikkeling is rekening gehouden met de elementen Digikoppeling Restful API Profiel en REST-API Ontwerpregels.

Implementatie

Voor hulp bij de implementatie en om de eerste stappen met de API te vergemakkelijken, is er documentatie beschikbaar op openonderwijsapi.nl. Een stappenplan is beschikbaar om tot een implementatie te komen: openonderwijsapi.nl/v6.0/#/implementation/implementation. Vanuit Npuls is er een OEAPI adoptieteam.

Ontwikkelingen

Deze OEAPI v6 is de vervolgversie van Edustandaard  afspraak OOAPI v5 (uit 2022) en Edustandaard afspraak OOAPI v4 (uit 2021). Deze versie 6 is ontwikkeld vanuit de OEAPI technische werkgroep met daarin enkele leveranciers en onderwijsinstellingen. De OEAPI community is gedurende het ontwikkeltraject geïnformeerd en geraadpleegd over de OEAPI v6 specificatie.

De OEAPI is aangeboden door de OEAPI technische werkgroep namens SURF om in beheer te worden genomen bij Edustandaard. De bestaande Werkgroep OOAPI zorgt voor doorontwikkeling van de standaard. Ook borgt deze werkgroep de afspraken met Edustandaard voor het beheer en de publicatie van updates en wijzigingen. Edustandaard begeleidt het proces voor vermelding van updates en wijzigingen op Edustandaard.nl en borging in de ROSA.

Documentatie

Versies

Bijeenkomsten