OSR:Hoofdpagina: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Geen bewerkingssamenvatting
kGeen bewerkingssamenvatting
 
(78 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 worden geraadpleegd.<br><br>


De volgende services worden door het OSR aangeboden: <br>
{|
|- 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>


[[OSR:2019/Opvragen_informatie_over_onderwijsinstelling|Opvragen informatie over onderwijsinstelling]]<br>
De volgende generieke user stories worden door de OSR API ondersteund:<br>
 
[[OSR:API/V2/Opvragen_informatie_over_onderwijsinstelling|1. Als API-gebruiker wil ik informatie over een onderwijsinstelling opvragen]]<br>
Ophalen van schoolinformatie en bijbehorende bestuursinformatie. Hier kan specifiek gezocht worden naar een school.<br>
Ophalen van schoolinformatie en bijbehorende bestuursinformatie. Hier kan specifiek gezocht worden naar een school.<br>


[[OSR:2019/Opvragen_mandaten|Opvragen mandaten]]<br>
[[OSR:API/V2/Opvragen_informatie_over_dienst|2. Als API-gebruiker wil ik informatie over een dienst of dienstversie opvragen]]<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>
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:2019/Opvragen_endpoints|Opvragen endpoints]]<br>
[[OSR:API/V2/Opvragen_endpoints|4. Als API-gebruiker wil ik een endpoint opvragen]]<br>
Iedereen met een PKI-overheidscertificaat kan de endpoints ophalen van een onderwijsinstelling/adminstratiekenmerk voor een bepaalde dienstversie.<br>
Ophalen van endpoints van een onderwijsinstelling of routeringskenmerk 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>
[[OSR:API/V2/toevoegen_en_wijzigen_van_endpoints|5. Als API-gebruiker wil ik een endpoint toevoegen of wijzigen]]<br>
De leverancier is gemandateerd voor de dienst door de onderwijsinstelling. Met een token kan een endpoint worden aangemaakt.<br> 
Endpoints aanmaken en wijzigen door een gemandateerd systeem.<br> 


De volgende services zijn nog niet beschikbaar, maar de verwachting is dat dit binnenkort beschikbaar komt:
{{Info|
 
Momenteel werken we aan een nieuwe versie van de API om ook mandateren op bestuursniveau mogelijk te maken.<br>
 
Bekijk [[OSR:API/V2/API_V2_naar_V3_wijzigingen|hier]] de veranderingen ten opzichte van de huidige versie.
<br>
}}
Opvragen diensten
<br>
Opvragen dienstversies 
<br>
Opvragen leveranciers 


{| cellspacing="10" cellpadding="5" border="0" width="90%"
| style="padding-left:4em" |
|- valign="top"
=== OSR kwalificatie ===
| style="width:60%" |  
[[:File:Kwalificatie test plan OSR.pdf|Kwalificatie test plan OSR 2.2]]


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


{| 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 20 mrt 2025 om 16:46


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.
Het register kan door iedereen met een PKI-overheidscertificaat/ODOC certificaat worden geraadpleegd.

De volgende generieke user stories worden door de OSR API ondersteund:

1. Als API-gebruiker wil ik informatie over een onderwijsinstelling opvragen
Ophalen van schoolinformatie en bijbehorende bestuursinformatie. Hier kan specifiek gezocht worden naar een school.

2. Als API-gebruiker wil ik informatie over een dienst of dienstversie opvragen
Ophalen van informatie over een dienst of dienstversie. Hier kan specifiek gezocht worden op een (deel van) de dienstnaam.

3. Als API-gebruiker wil ik het mandaat van een systeem valideren
Verifiëren of de onderwijsinstelling een mandaat heeft afgegeven aan een systeem.

4. Als API-gebruiker wil ik een endpoint opvragen
Ophalen van endpoints van een onderwijsinstelling of routeringskenmerk voor een bepaalde dienstversie.

5. Als API-gebruiker wil ik een endpoint toevoegen of wijzigen
Endpoints aanmaken en wijzigen door een gemandateerd systeem.
 

Info.gif

Momenteel werken we aan een nieuwe versie van de API om ook mandateren op bestuursniveau mogelijk te maken.
Bekijk hier de veranderingen ten opzichte van de huidige versie.

OSR kwalificatie

Kwalificatie test plan OSR 2.2

Hotlinks

API documentatie
OSR Omgevingen
OSR Dienst versies

Security

Kennisnet standaarden rondom
beveiligd gegevenstransport.

Ondersteuning

Begrippenlijst
Veelgestelde vragen