OSR:Hoofdpagina: verschil tussen versies

Versie van 20 jun 2025 13:44

Over het OSR

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

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

De OSR API
Voor partijen die via 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:

1.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).

2. 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.

3. 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.

4. Endpoints toevoegen, bewerken, verwijderen en opvragen
Systemen registreren via de OSR API per school op welke endpoints (URL) 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.

Onlangs is versie 3 van de API uitgebracht om mandateren op bestuursniveau mogelijk te maken.
Bekijk hier de veranderingen ten opzichte van de vorige versie.

OSR kwalificatie

Kwalificatie test plan OSR 2.2

Hotlinks

API-documentatie
OSR Omgevingen
OSR Dienstversies

Security

Kennisnet standaarden rondom
beveiligd gegevenstransport.

Ondersteuning

Begrippenlijst
Veelgestelde vragen

@@ Regel 1: / Regel 1: @@
 __NOTOC__
+''' Over het OSR'''
 {|
 |- style="vertical-align:top"
 | De voorziening Onderwijs Serviceregister (OSR) vervult de rol van “telefoonboek” voor de onderwijsketen. <br>
 In het OSR worden de relatie tussen scholen, leveranciers en diensten vastgelegd. Hiermee biedt het OSR een standaardoplossing omtrent routerings- en autorisatievraagstukken. <br>
-Het register kan door iedereen met een PKI-overheidscertificaat/ODOC certificaat worden geraadpleegd.<br><br>
+<br>
+''' De OSR API'''<br>
+Voor partijen die via 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.<br>
+De volgende functionaliteiten worden door de OSR API ondersteund:<br>
+<br><br>
+[[OSR:API/V2/Opvragen_informatie_over_onderwijsinstelling|1.Basisinformatie over onderwijsinstellingen opvragen]]<br>
+De gebruiker kan informatie over scholen en besturen in OSR opvragen. Deze informatie is gebaseerd op de instellingsgegevens van [https://duo.nl/zakelijk/voortgezet-onderwijs/instellingsgegevens/rio/ RIO].<br>
+Filteren kan op naamgegevens en gestandaardiseerde identificatienummers (OIN, BGE-code, OIE code).<br>
+<br>
+[[OSR:API/V2/Opvragen_informatie_over_dienst|2. Informatie over een dienst of dienstversie opvragen]]<br>
+OSR bevat informatie over diverse diensten en ketensamenwerkingen. Met de OSR API kan de gebruiker namen, omschrijvingen en onderliggende versies opvragen.<br>
+<br>
+[[OSR:API/V2/Valideren_mandaat|3. Het mandaat van een systeem valideren]]<br>
+In OSR registreren scholen en schoolbesturen mandaten voor de leveranciers die namens hun privacygevoelige gegevens mogen verwerken.<br>
+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.<br>
+<br>
-De volgende generieke user stories worden door de OSR API ondersteund:<br>
+[[OSR:API/V2/Opvragen_endpoints|4. Endpoints toevoegen, bewerken, verwijderen en opvragen]]<br>
+Systemen registreren via de OSR API per school op welke endpoints (URL) zij gegevens willen ontvangen voor het het berichtenverkeer voor een bepaalde dienst.<br>
-[[OSR:API/V2/Opvragen_informatie_over_onderwijsinstelling|1. Als API-gebruiker wil ik informatie over een onderwijsinstelling opvragen]]<br>
+Hierbij wordt een routeringskenmerk meegegeven en het datumbereik waarbinnen het endpoint geldig is.<br>
-Ophalen van schoolinformatie en bijbehorende bestuursinformatie. Hier kan specifiek gezocht worden naar een school.<br>
+Systemen vragen deze endpoints van elkaar op en bepalen op deze manier waar berichten heen moeten worden gestuurd.<br>
+<br>
-[[OSR:API/V2/Opvragen_informatie_over_dienst|2. Als API-gebruiker wil ik informatie over een dienst of dienstversie opvragen]]<br>
+<br>
-Ophalen van informatie over een dienst of dienstversie. Hier kan specifiek gezocht worden op een (deel van) de dienstnaam.<br>
-[[OSR:API/V2/Valideren_mandaat|3. Als API-gebruiker wil ik het mandaat van een systeem valideren]]<br>
-Verifiëren of de onderwijsinstelling een mandaat heeft afgegeven aan een systeem.<br>
-[[OSR:API/V2/Opvragen_endpoints|4. Als API-gebruiker wil ik een endpoint opvragen]]<br>
-Ophalen van endpoints van een onderwijsinstelling of routeringskenmerk voor een bepaalde dienstversie.<br>
-[[OSR:API/V2/toevoegen_en_wijzigen_van_endpoints|5. Als API-gebruiker wil ik een endpoint toevoegen of wijzigen]]<br>
-Endpoints aanmaken en wijzigen door een gemandateerd systeem.<br>
 {{Info|