OSR:Hoofdpagina: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Geen bewerkingssamenvatting
kGeen bewerkingssamenvatting
 
(88 tussenliggende versies door 3 gebruikers niet weergegeven)
Regel 1: Regel 1:
__NOTOC__
__NOTOC__
De voorziening Onderwijs Serviceregister (OSR) zal de rol van “telefoonboek” voor de onderwijsketen vervullen. <br>
In het OSR worden de relatie tussen scholen, leveranciers en diensten vastgelegd. Hiermee zal het OSR een standaardoplossing bieden omtrent routerings- en autorisatievraagstukken. <br>
Het register kan door iedereen met een PKI-overheidscertificaat/ODOC certificaat worden geraadpleegd.<br><br>


De volgende user stories worden door het OSR ondersteund<br>
<h2>Over het OSR</h2>
{|
|- style="vertical-align:top"
| Het [https://www.kennisnet.nl/diensten/onderwijs-service-register/ 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>
<br>
<h2>De OSR API</h2><br>
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.<br>
De volgende functionaliteiten worden door de OSR API ondersteund:<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>


[[OSR:2019/Opvragen_informatie_over_onderwijsinstelling|Ik wil informatie over een onderwijsintelling opvragen]]<br>
[[OSR:API/V2/Opvragen_endpoints|4. Endpoints toevoegen, bewerken, verwijderen en opvragen]]<br>
Ophalen van schoolinformatie en bijbehorende bestuursinformatie. Hier kan specifiek gezocht worden naar een school.<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>
 
Hierbij wordt een routeringskenmerk meegegeven en het datumbereik waarbinnen het endpoint geldig is.<br>
[[OSR:2019/Opvragen_mandaten|Opvragen mandaten]]<br>
Systemen vragen deze endpoints van elkaar op en bepalen op deze manier waar berichten heen moeten worden gestuurd.<br>
Voordat een leverancier een endpoint kan aanmaken voor de dienst en onderwijsinstelling, is het nodig om te verifiëren of de onderwijsinstelling een mandaat heeft aangemaakt voor de leverancier.<br>
 
[[OSR:2019/Opvragen_endpoints|Opvragen endpoints]]<br>
Iedereen met een PKI-overheidscertificaat kan de endpoints ophalen van een onderwijsinstelling/adminstratiekenmerk voor een bepaalde dienstversie.<br>
Het endpoint omvat informatie zoals het afleveradres(technische url) van de gekoppelde leverancier, ingangsdatum, einddatum etc.. <br>
 
[[OSR:2019/toevoegen_en_wijzigen_van_endpoints|Toevoegen en wijzigen van endpoints]]<br>
De leverancier is gemandateerd voor de dienst door de onderwijsinstelling. Met een token kan een endpoint worden aangemaakt.<br> 
 
De volgende services zijn nog niet beschikbaar, maar de verwachting is dat dit binnenkort beschikbaar komt:
 
 
<br>
<br>
Opvragen diensten
<br>
<br>
Opvragen dienstversies 
<br>
Opvragen leveranciers 


{| cellspacing="10" cellpadding="5" border="0" width="90%"
{{Info|
|- valign="top"
* Voor het bevragen van de OSR API heeft u een PKIoverheidcertificaat nodig. Op [https://www.logius.nl/domeinen/toegang/pkioverheid/wat-een-pkioverheidcertificaat deze] pagina van Logius vindt u meer informatie.
| style="width:60%" |  
* Om informatie via de OSR API te kunnen bewerken kunt u [https://www.kennisnet.nl/contact/ contact] opnemen met Kennisnet voor ondersteuning bij uw implementatie.
* Onlangs is OSR API versie 3 uitgebracht om mandateren op bestuursniveau mogelijk te maken. Lees [[OSR:API/V2/API_V2_naar_V3_wijzigingen|hier]] de vernieuwingen ten opzichte van de vorige versie.
}}
 
| style="padding-left:4em" |
=== OSR kwalificatie ===
[[:File:Kwalificatie test plan OSR.pdf|Kwalificatie testplan OSR 2.2]]


=== Hotlinks ===
[https://osr.kennisnet.nl/api/v3/documentation API-documentatie]<br/>
[[OSR:omgevingen|OSR Omgevingen]]<br/>
[[OSR:dienst-versies|OSR Dienstversies]]


{| cellspacing="10" cellpadding="5" border="0" width="90%"
=== Security ===
|- valign="top"
| style="width:60%"|


=== OSR specificatie ===
Kennisnet standaarden rondom<br>[https://developers.wiki.kennisnet.nl/index.php?title=Standaarden:Beveiligd_Gegevenstransport beveiligd gegevenstransport].
| style="width:40%" |


=== Hotlinks ===
=== Ondersteuning ===
{{ComItem|Homepage|api documentatie|https://osr-sb.kennisnet.nl/api/v1/doc}}
{{ComItem|Homepage|jwt.io|https://jwt.io/}}


[[OSR:Begrippenlijst|Begrippenlijst]]<br>
[[OSR:Veelgestelde_vragen|Veelgestelde vragen]]


=== Communicatie ===
[[Category:OSR]]
{{ComItem|Homepage|Onderwijs Service Register|http://www.osr.nl/}}
|}

Huidige versie van 1 jul 2025 14:34


Over het OSR

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


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.
  • Onlangs 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

Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSR:Hoofdpagina&oldid=13169"