OSR:Hoofdpagina

Uit Kennisnet Developers Documentatie
(Doorverwezen vanaf OSR:API)
Naar navigatie springen Naar zoeken springen

Onderwijs Serviceregister-symbol.png Onderwijs Serviceregister: Hoofdpagina


Over het OSR

Het Onderwijs Serviceregister (OSR) vervult de rol van “telefoonboek” voor de onderwijsketen.

In het OSR worden de relatie tussen onderwijsinstellingen, leveranciers en diensten vastgelegd. Hiermee biedt het OSR een standaardoplossing omtrent routerings- en autorisatievraagstukken.

De OSR API


Voor partijen die geautomatiseerd gebruik willen maken van het register is een REST API beschikbaar. Hiermee kan OSR eenvoudig worden geïntegreerd in de uitwisseling van berichten tussen systemen.
De volgende functionaliteiten worden door de OSR API ondersteund:

Het mandaat van een systeem valideren

In OSR registreren scholen en schoolbesturen mandaten voor de leveranciers die namens hun privacygevoelige gegevens mogen verwerken.
Systemen kunnen met de OSR API opvragen of zij (of een systeem dat met hun wil uitwisselen) een geldig mandaat van de onderwijsinstelling hebben ontvangen.

Een systeem het eigen mandaat of een lijst van mandaten voor een dienst op te vragen.
Bij een specifiek mandaat bevat het resultaat een mandaattoken, welke benodigd is bij het registreren van een endpoint.

Ook andere partijen binnen de ketenvoorziening kunnen verifiëren of een systeem gemandateerd is namens een onderwijsinstelling voor een bepaalde dienst.

Endpoints opvragen, toevoegen, bewerken en verwijderen

Systemen registreren via de OSR API per onderwijsinstelling op welke endpoints (URLs) zij gegevens willen ontvangen voor het het berichtenverkeer voor een bepaalde dienst.
Hierbij wordt een routeringskenmerk meegegeven en het datumbereik waarbinnen het endpoint geldig is.
Systemen vragen deze endpoints van elkaar op en bepalen op deze manier waar berichten heen moeten worden gestuurd.

Basisinformatie over onderwijsinstellingen opvragen

De gebruiker kan informatie over scholen en besturen in OSR opvragen. Deze informatie is gebaseerd op de instellingsgegevens van RIO.
Filteren kan op naamgegevens en gestandaardiseerde identificatienummers (OIN, BGE-code, OIE-code).

Informatie over een dienst of dienstversie opvragen

OSR bevat informatie over diverse diensten en ketensamenwerkingen. Met de OSR API kan de gebruiker namen, omschrijvingen en onderliggende versies opvragen.

Info.gif
  • Voor het bevragen van de OSR API heeft u een PKIoverheidcertificaat nodig. Op deze pagina van Logius vindt u meer informatie.
  • Om informatie via de OSR API te kunnen bewerken kunt u contact opnemen met Kennisnet voor ondersteuning bij uw implementatie.
  • In april 2025 is OSR API versie 3 uitgebracht om mandateren op bestuursniveau mogelijk te maken. Lees hier de vernieuwingen ten opzichte van de vorige versie.

OSR kwalificatie

Kwalificatie testplan OSR 2.2

Hotlinks

API-documentatie
OSR Omgevingen
OSR Dienstversies

Security

Kennisnet standaarden rondom
beveiligd gegevenstransport.

Ondersteuning

Begrippenlijst
Veelgestelde vragen