Uit Kennisnet Developers Documentatie
Naar navigatie springen
Naar zoeken springen
|
|
Regel 32: |
Regel 32: |
|
| |
|
| {{Info| | | {{Info| |
| Onlangs is versie 3 van de API uitgebracht om mandateren op bestuursniveau mogelijk te maken.<br> | | * 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. |
| Bekijk [[OSR:API/V2/API_V2_naar_V3_wijzigingen|hier]] de veranderingen ten opzichte van de vorige versie.
| | * Om informatie via de OSR API te kunnen bewerken kunt u contact opnemen met Kennisnet voor ondersteuning bij uw implementatie en het ontvangen van API-keys. |
| | * 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. |
| }} | | }} |
|
| |
|
Versie van 20 jun 2025 13:57
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.
|
- 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 en het ontvangen van API-keys.
- 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 test plan OSR 2.2
Hotlinks
API-documentatie
OSR Omgevingen
OSR Dienstversies
Security
Kennisnet standaarden rondom beveiligd gegevenstransport.
Ondersteuning
Begrippenlijst
Veelgestelde vragen
|