Technische vereisten gegevensdiensten

Owned by Koen Voermans
Last updated: Oct 01, 2024
3 min read

Titel

Technische vereisten gegevensdiensten

Status

In ontwikkeling ROSA-Architectuurscan BEsluitvorming implementatie in beheer

Versie

0.9.1

Datum

27 September 2024

Auteur

Architectenraad Edu-V

Acties

  • Op basis van de uitwerking van de praktijksituaties worden de gegevensdiensten geactualiseerd.

In onderstaand overzicht is voor ieder van de Edu-V gegevensdiensten aangegeven wat de technische vereisten zijn die gesteld worden aan de infrastructuur en het consentmanagement. Deze vereisten zijn gebaseerd op basis van de classificatie van het informatieobject zoals deze is vastgelegd in het architectuurkader Edu-V.

Ten aanzien van de infrastructuur zijn de volgende elementen benoemd:

  • Client: een standaard OAuth2.0 Client om te communiceren met een OAuth2.0 autorisatieserver.

  • PKIoverheid certificaat: het PKIoverheid certificaat wordt gebruikt bij de M2M identificatie, authenticatie en autorisatie om een token aan te vragen bij de autorisatieserver middels het private_key_jwt mechanisme. Voor meer informatie zie M2M identificatie authenticatie en autorisatie.

  • Autorisatieserver: een OAuth2.0 autorisatieserver om Afnemers of Verzenders te identificeren en te authenticeren conform de M2M identificatie authenticatie en autorisatie.

  • Resourceserver: een resourceserver waar een Client een bevraging, melding of terugmelding kan doen.

Ten aanzien van het Consent zijn de volgende elementen benoemd:

  • UI: een gebruikersinterface waarin de applicatiebeheerder van de onderwijsaanbieder een gegevensuitwisseling kan autoriseren (toestemming verlenen of intrekken).

  • Registratie: een registratie van toestemmingen die zijn verleend aan of vanuit referentiecomponenten van andere leveranciers.

  • Consent API: de Consent API waarin een Consent Consumer de status van een Consent kan opvragen, een Consent kan melden of Consentbevestigingen kan opvragen. Ook kan de Consent API Consent notificaties van een andere Consent API ontvangen en/of bevestigingen.

  • Consent Consumer: een Client applicatie die bij een Consent API de status van een Consent kan opvragen, een Consent kan melden of Consentbevestigingen kan opvragen.

Voor ieder van deze elementen is aangegeven of deze verplicht (!), optioneel (*) of niet van toepassing (-) zijn voor de combinatie van gegevensdienst, referentiecomponent en transactierol. In de kolom Consent Consumer wordt de combinatie van verplicht en optioneel ((!*) weergegeven. Een leverancier heeft de keuze om Consent Consumer of Consent API toe te passen, waarbij de minimale vereiste Consent Consumer is.

Laagdrempeligheid

Om de toetredingsdrempels tot het Ecosysteem zo laag mogelijk te houden is het voor referentiecomponenten die enkel als Afnemer of Verzender optreden in de gegevensdiensten geen noodzaak tot het implementeren van een API. Zij kunnen met een Client en Consent Consumer gegevens opvragen uit de Bron of verzenden naar de Ontvanger.

Gegevensdienst

API

Scope

Referentiecomponent

Transactie-rol

Infrastructuur

Consent

Client

PKIoverheid certificaat

Autorisatie-server

Resource-server

UI

Registratie

Consent Consumer

Consent API

Onderwijsaanbod

Education

eduv.education

Administratiesysteem onderwijsdeelnemer

Bron

–

–

!

!

!

!

–

*

Selectieomgeving leermiddelen

Bestelomgeving leermiddelen

Aanspraakmanager

Leermiddelenportaal

Onderwijsleeromgeving

Leermiddelendashboard

Dienst met SSO

Authenticerende Dienst

Afnemer

!

!

–

–

!

!

*

*

Onderwijsinrichting

Association

eduv.association

Administratiesysteem onderwijsdeelnemer

Bron

–

–

!

!

!

!

–

*

Bestelomgeving leermiddelen

Aanspraakmanager

Dienst met SSO

Authenticerende Dienst

Afnemer

!

!

–

–

!

!

*

*

Onderwijs-deelnemers

Students

eduv.student.
basic

Administratiesysteem onderwijsdeelnemer

Bron

–

–

!

!

!

!

–

*

Bestelomgeving leermiddelen

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Afnemer

!

!

–

–

!

!

*

*

eduv.student.
communication

Administratiesysteem onderwijsdeelnemer

Bron

–

–

!

!

!

!

–

*

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Afnemer

!

!

–

–

!

!

*

*

eduv.student.
demographics

Administratiesysteem onderwijsdeelnemer

Bron

–

–

!

!

!

!

–

*

Digitaal toetssysteem

Afnemer

!

!

–

–

!

!

*

*

eduv.student.
accessibility

Administratiesysteem onderwijsdeelnemer

Bron

–

–

!

!

!

!

–

*

Nog geen afnemers

Afnemer

!

!

–

–

!

!

*

*

eduv.student.
deliveryaddress

Administratiesysteem onderwijsdeelnemer

Bron

–

–

!

!

!

!

–

*

Bestelomgeving leermiddelen

Afnemer

!

!

–

–

!

!

*

*

Ondewijs-medewerkers

Employees

eduv.employee.
basic

Administratiesysteem onderwijsmedewerker

Bron

–

–

!

!

!

!

–

*

Administratiesysteem onderwijsdeelnemer

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Bestelomgeving leermiddelen

Afnemer

!

!

–

–

!

!

*

*

eduv.employee.
communication

Administratiesysteem onderwijsmedewerker

Bron

–

–

!

!

!

!

–

*

Administratiesysteem onderwijsdeelnemer

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Afnemer

!

!

–

–

!

!

*

*

eduv.employee.
roles

Administratiesysteem onderwijsmedewerker

Bron

–

–

!

!

!

!

–

*

Administratiesysteem onderwijsdeelnemer

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Afnemer

!

!

–

–

!

!

*

*

Leermiddelen

Catalogue

eduv.catalogue

Leveranciersspecifieke leermiddelencatalogus

Bron

–

–

*

* of een file

–

–

–

–

Overkoepelende leermiddelencatalogus

Bestelomgeving leermiddelen

Selectieomgeving leermiddelen

Leermiddelenportaal

Aanspraakmanager

Leermiddelendashboard

Afnemer

!

*

–

–

–

–

–

–

Leermaterialen

Course API

eduv.course

Leermaterialencatalogus

Bron

–

–

*

* of een file

–

–

–

–

Overkoepelende leermiddelencatalogus

Onderwijsleeromgeving

Leermiddelendashboard

Afnemer

!

*

–

–

–

–

–

–

Leveringsorders

Delivery API

eduv.delivery.
entitlor

Bestelomgeving leermiddelen

Verzender
Ontvanger
Bron

!

!

!

!

–

–

–

–

Aanspraakmanager

Ontvanger
Verzender
Afnemer

!

!

!

!

–

–

–

–

eduv.delivery.
licensor

Bestelomgeving leermiddelen

Bron

–

–

!

!

–

–

–

–

Licentieregistratie

Afnemer

!

!

–

–

–

–

–

–

eduv.delivery.
dashboard

Bestelomgeving leermiddelen

Bron

–

–

!

!

!

!

–

*

Leermiddelendashboard

Afnemer

!

!

–

–

!

!

*

*

eduv.delivery.
portal

Bestelomgeving leermiddelen

Bron

–

–

!

!

!

!

–

*

Leermiddelenportaal

Afnemer

!

!

–

–

!

!

*

*

Aanspraken

Entitlement

eduv.entitlement.
licensor

Aanspraakmanager

Verzender
Ontvanger
Bron

!

!

!

!

–

–

–

–

Licentieregistratie

Ontvanger
Verzender
Afnemer

!

!

!

!

–

–

–

–

eduv.entitlement.
seller

Aanspraakmanager

Bron

–

–

!

!

–

–

–

–

Bestelomgeving leermiddelen

Afnemer

!

!

–

–

–

–

–

–

eduv.entitlement.
portal
(asynchrone uitwisseling)

Aanspraakmanager

Verzender
Ontvanger
Bron

!

!

!

!

!

!

*

*

Leermiddelenportaal

Ontvanger
Verzender
Afnemer

!

!

!

!

!

!

–

*

eduv.entitlement.
portal (bevraging)

Aanspraakmanager

Bron

–

–

!

!

!

!

–

*

Leermiddelenportaal

Afnemer

!

!

–

–

!

!

*

*

eduv.entitlement.
dashboard

Aanspraakmanager

Bron

–

–

!

!

!

!

–

*

Leermiddelendashboard

Afnemer

!

!

–

–

!

!

*

*

Leermiddelactivatie

Usage

eduv.usage.
entitlor

Licentieregistratie

Verzender

!

!

–

–

–

–

–

–

Aanspraakmanager

Ontvanger

–

–

!

!

–

–

–

–

Leermiddelgebruik

Usage

eduv.usage.
seller

Licentieregistratie

Bron

–

–

!

!

–

–

–

–

Bestelomgeving leermiddelen

Afnemer

!

!

–

–

–

–

–

–

eduv.usage.
entitlor

Licentieregistratie

Bron

–

–

!

!

–

–

–

–

Aanspraakmanager

Afnemer

!

!

–

–

–

–

–

–

eduv.usage.
dashboard

Licentieregistratie

Bron

–

–

!

!

!

–

–

*

Leermiddelendashboard

Afnemer

!

!

–

–

!

!

*

*

Leermiddelorders (B2B inkoop)

Order

eduv.order

Bestelomgeving leermiddelen

Verzender
Ontvanger

!

!

!

!

–

–

–

–

Ordersysteem leermiddelen

Ontvanger
Verzender

!

!

!

!

–

–

–

–

Activatiecode-verzoek

Activation
Code

eduv.activationcode

Bestelomgeving leermiddelen

Verzender
Ontvanger

!

!

!

!

–

–

–

–

Licentieregistratie

Ontvanger
Verzender

!

!

!

!

–

–

–

–

Leermateriaal-gebruik

Progress API

eduv.progress

Gebruiksomgeving digitaal leermateriaal

Digitaal toetssysteem

Verzender

!

!

–

–

!

!

*

*

Leermiddelendashboard

Ontvanger

–

–

!

!

!

!

–

*

Leerresultaten

Results API

eduv.results

Digitaal toetssysteem

Gebruiksomgeving digitaal leermateriaal

Verzender

!

!

–

–

!

!

*

*

Administratiesysteem leerresultaten

Leermiddelendashboard

Ontvanger

–

–

!

!

!

!

–

*

Consent

Consent API

eduv.consent

Consentmanagement

Bron

–

–

!

!

!

!

–

*

Consentdashboard

Afnemer

!

!

–

–

!

!

*

*

Verwerkersovereenkomst

DPA API

eduv.dpa

Verwerkersregister

Bron

–

–

!

!

!

!

–

*

Consentmanagement

Consentdashboard

Afnemer

!

!

–

–

!

!

*

*

Release notes

Deze uitwerking is gebaseerd op basis van de volgende stappen:

  • 0.0.1: Tekst is overgenomen uit de pagina Gegevensdiensten.

  • 0.0.2: Gegevensdiensten van SIS API opgesplitst in:

    • Onderwijsadministratie

    • Adresgegevens fijndistributie

    • Vakinformatie

  • 0.0.3: De pagina is besproken tijdens de bijeenkomst van de Architectenraad Edu-V en is gereed voor de ROSA-architectuurscan.

  • 0.0.4: Technische vereisten bijgewerkt op basis van nieuwe APIs en wijziging M2M identificatie, authenticatie en autorisatie.

  • 0.0.5: Consistentie van referentiecomponenten toegangsketen bijgewerkt.

  • 0.9.0: Het Architectuurkader Edu-V is vastgesteld als startpunt voor de implementatie. Tevens is instemming verleend op verdere doorontwikkeling van het Architectuurkader Edu-V op basis van de Architectuurprincipes. Dit akkoord is verleend op het Bestuurlijk Overleg van 27 mei 2024.

    • De gegevensdiensten worden tijdens de plateau- en releaseplanning geïmplementeerd. Na een succesvolle implementatie wordt de uiteindelijke 1.0.0 versie vastgesteld.

  • 0.9.1: Wijzigingen naar aanleiding van RFC’s:

    • Op basis van RFC002 is de scope aangepast met een prefix eduv.. Dit stelt leveranciers in staat om onderscheid te maken tussen gegevensuitwisselingen met leveranciers binnen en buiten het Edu-V afsprakenstelsel.

    • Op basis van RFC011 is de kolom PKIoverheid certificaat toegevoegd. Zo is bij iedere gegevensdienst duidelijk welke transactierol het PKIoverheid certificaat dient toe te passen.

 

Disclaimer en licentie