Technische vereisten gegevensdiensten

Titel

Technische vereisten gegevensdiensten

Status

In ontwikkeling ROSA-Architectuurscan BEsluitvorming implementatie in beheer

Versie

0.0.5

Datum

24 Mei 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.

  • 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

Autorisatie-server

Resource-server

UI

Registratie

Consent Consumer

Consent API

Onderwijs-aanbod

Education

education

Administratiesysteem onderwijsdeelnemer

Bron

!

!

!

!

!

Selectieomgeving leermiddelen

Bestelomgeving leermiddelen

Aanspraakmanager

Leermiddelenportaal

Onderwijsleeromgeving

Leermiddelendashboard

Dienst met SSO

Authenticerende Dienst

Afnemer

!

!

!

!*

*

Onderwijs-inrichting

Association

association

Administratiesysteem onderwijsdeelnemer

Bron

!

!

!

!

!

Bestelomgeving leermiddelen

Aanspraakmanager

Dienst met SSO

Authenticerende Dienst

Afnemer

!

!

!

!*

*

Onderwijs-deelnemers

Students

student.
basic

Administratiesysteem onderwijsdeelnemer

Bron

!

!

!

!

!

Bestelomgeving leermiddelen

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Afnemer

!

!

!

!*

*

student.
communication

Administratiesysteem onderwijsdeelnemer

Bron

!

!

!

!

!

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Afnemer

!

!

!

!*

*

student.
demographics

Administratiesysteem onderwijsdeelnemer

Bron

!

!

!

!

!

Digitaal toetssysteem

Afnemer

!

!

!

!*

*

student.
accessibility

Administratiesysteem onderwijsdeelnemer

Bron

!

!

!

!

!

Nog geen afnemers

Afnemer

!

!

!

!*

*

student.
deliveryaddress

Administratiesysteem onderwijsdeelnemer

Bron

!

!

!

!

!

Bestelomgeving leermiddelen

Afnemer

!

!

!

!*

*

Ondewijs-medewerkers

Employees

employee.
basic

Administratiesysteem onderwijsmedewerker

Bron

!

!

!

!

!

Administratiesysteem onderwijsdeelnemer

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Bestelomgeving leermiddelen

Afnemer

!

!

!

!*

*

employee.
communication

Administratiesysteem onderwijsmedewerker

Bron

!

!

!

!

!

Administratiesysteem onderwijsdeelnemer

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Afnemer

!

!

!

!*

*

employee.
roles

Administratiesysteem onderwijsmedewerker

Bron

!

!

!

!

!

Administratiesysteem onderwijsdeelnemer

Dienst met SSO

Authenticerende Dienst

Authenticerende Identity Provider

Delegerende Identity Provider

Afnemer

!

!

!

!*

*

Leermiddelen

Catalogue

catalogue

Leveranciersspecifieke leermiddelencatalogus

Bron

*

* of een file

Overkoepelende leermiddelencatalogus

Bestelomgeving leermiddelen

Selectieomgeving leermiddelen

Leermiddelenportaal

Aanspraakmanager

Leermiddelendashboard

Afnemer

!

Leermaterialen

Course API

course

Leermaterialencatalogus

Bron

*

* of een file

Overkoepelende leermiddelencatalogus

Onderwijsleeromgeving

Leermiddelendashboard

Afnemer

!

Leveringsorders

Delivery API

delivery.
entitlor

Bestelomgeving leermiddelen

Verzender
Ontvanger
Bron

!

!

!

Aanspraakmanager

Ontvanger
Verzender
Afnemer

!

!

!

delivery.
licensor

Bestelomgeving leermiddelen

Bron

!

!

Licentieregistratie

Afnemer

!

delivery.
dashboard

Bestelomgeving leermiddelen

Bron

!

!

!

!

!

Leermiddelendashboard

Afnemer

!

!

!

!*

*

delivery.
portal

Bestelomgeving leermiddelen

Bron

!

!

!

!

!

Leermiddelenportaal

Afnemer

!

!

!

!*

*

Aanspraken

Entitlement

entitlement.
licensor

Aanspraakmanager

Verzender
Ontvanger
Bron

!

!

!

Licentieregistratie

Ontvanger
Verzender
Afnemer

!

!

!

entitlement.
seller

Aanspraakmanager

Bron

!

!

!

Bestelomgeving leermiddelen

Afnemer

!

entitlement.
portal
(asynchrone uitwisseling)

Aanspraakmanager

Verzender
Ontvanger
Bron

!

!

!

!

!

!*

*

Leermiddelenportaal

Ontvanger
Verzender
Afnemer

!

!

!

!

!

!

entitlement.
portal (bevraging)

Aanspraakmanager

Bron

!

!

!

!

!

!

Leermiddelenportaal

Afnemer

!

!

!

!*

*

entitlement.
dashboard

Aanspraakmanager

Bron

!

!

!

!

!

!

Leermiddelendashboard

Afnemer

!

!

!

!*

*

Leermiddel-activatie

Usage

usage.
entitlor

Licentieregistratie

Verzender

!

Aanspraakmanager

Ontvanger

!

!

Leermiddel-gebruik

Usage

usage.
seller

Licentieregistratie

Bron

!

!

Bestelomgeving leermiddelen

Afnemer

!

usage.
entitlor

Licentieregistratie

Bron

!

!

Aanspraakmanager

Afnemer

!

usage.
dashboard

Licentieregistratie

Bron

!

!

!

!

Leermiddelendashboard

Afnemer

!

!

!

!*

*

Leermiddelorders (B2B inkoop)

Order

order

Bestelomgeving leermiddelen

Verzender
Ontvanger

!

!

!

Ordersysteem leermiddelen

Ontvanger
Verzender

!

!

!

Activatiecode-verzoek

Activation
Code

activationcode

Bestelomgeving leermiddelen

Verzender
Ontvanger

!

!

!

Licentieregistratie

Ontvanger
Verzender

!

!

!

Leermateriaal-gebruik

Progress API

progress

Gebruiksomgeving digitaal leermateriaal

Digitaal toetssysteem

Verzender

!

!

!

!*

*

Leermiddelendashboard

Ontvanger

!

!

!

!

!

Leerresultaten

Results API

results

Digitaal toetssysteem

Gebruiksomgeving digitaal leermateriaal

Verzender

!

!

!

!*

*

Administratiesysteem leerresultaten

Leermiddelendashboard

Ontvanger

!

!

!

!

!

Consent

Consent API

consent

Consentmanagement

Bron

!

!

!

!

!

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.