Open Onderwijs API 5.0

Beschrijving

De afspraak Open Onderwijs API (OOAPI) beschrijft het data-formaat (REST-API en JSON), semantiek en syntax waaraan onderwijsinstellingen moeten voldoen om informatie beschikbaar te kunnen stellen aan externe partijen. Dit betreft: persoonsgegevens, faculteitsgegevens, onderwijsafdelingen, onderwijsplannen, cursusgroepen, cursussen, cursusresultaten, toetsresultaten, gebouwen, ruimtes, roostergegevens, nieuwskanalen, nieuwsitems, enzovoort.
De afspraak is mede bedoeld om app-bouwers in het onderwijs te helpen om deze data te ontsluiten op een gepersonaliseerde manier (voor de student) via een app.

Samenhang

Met het opzetten van de OOAPI is rekening gehouden met elementen uit de HORA. Er is geen sprake van een onderlinge verwijzing.

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

Meerwaarde

Steeds meer onderwijs instellingen werken aan een flexibele en persoonlijke leeromgeving: die is modulair van opzet en is opgebouwd uit verschillende applicaties van binnen en buiten de instelling. De integratie-infrastructuur zorgt voor uitwisseling van data en functionaliteit tussen deze losse applicaties. API’s zijn de interfaces tussen verschillende softwareapplicaties en zijn daardoor een onmisbaar onderdeel van een integratie-infrastructuur. Zo kunnen onderwijsinstellingen bijvoorbeeld via apps handige informatie beschikbaar stellen: van cijfers tot studiepunten, van roosters tot vrije werkplekken. Meer informatie staat op openonderwijsapi.nl.

Gebruik

De OOAPI is een open standaard die door iedereen kan worden gebruikt, zonder restricties. Door de OOAPI te gebruiken, kunnen organisaties en ontwikkelaars eenvoudig integraties bouwen en gegevens op een uniforme manier uitwisselen. De API is gebaseerd op industriestandaarden, wat ervoor zorgt dat ontwikkelaars snel aan de slag kunnen en de implementatie zo soepel mogelijk verloopt.

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/#/technical/implementation.

Ontwikkelingen

De OOAPI is aangeboden door SURF namens de projectgroep OOAPI 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.