Consortium Digibib API

Inleiding

De Digibib van Stichting Consortium Beroepsonderwijs is het platform waar het Consortium digitale leermiddelen aanbiedt aan leerlingen en docenten. Middels de API voor de Digibib kunnen ook derden toegang tot hun content aanbieden aan leerlingen en docenten via de Digibib. Hier treft u documentatie betreffende de technische werking van de API. Met vragen over de mogelijkheden om als aanbieder van deze dienst gebruik te maken neemt u contact op met icthelpdesk@consortiumbo.nl

Digibib API documentatie: Concept v.0.1. De Digibib API is in ontwikkeling. Deze documentatie beschrijft de technische concepten op hoofdlijnen, de uitwerking is work in progress. Gedurende de verdere implementatie worden specificatie en voorbeelden van API calls toegevoegd. Aan deze documentatie kunnen dan ook geen rechten worden ontleend.

Hoe werkt het?

Een geautoriseerde content-leverancier kan digitale leermiddelen aanmelden in de Digibib. Deze digitale leermiddelen worden vervolgens opgenomen in de online catalogus van de Digibib. Vanuit deze catalogus kan een leerling of docent toegang tot één of meerdere digitale leermiddelen afnemen.

De digitale leermiddelen van de content-leverancier worden primair ontsloten via de website(s) van de content-leverancier. De Digibib API regelt het aanbieden van de leermiddelen en het abonneren daar op, en niet de fysieke publicatie, beschikbaarheid en autorisatie. Middels Single Sing-on verkrijgt de geautoriseerde leerling of docent via de Digibib toegang tot de content op de website(s) van de content-leverancier.

Het proces op hoofdlijnen:

• de content-leverancier voegt leermiddelen toe aan de Digibib catalogus;
• een leerling of docent logt in op de Digibib;
• een leerling of docent neemt één of meerdere leermiddelen af via de Digibib;
• een leerling of docent selecteert binnen de Digibib een leermiddel waartoe hij/zij toegang heeft;
• de Digibib stuurt een leerling of docent door naar het leermiddel op de website van de content-leverancier;
• leerling of docent wordt ingelogd via Single Sing-on en krijgt toegang tot het leermiddel op de website van de content-leverancier;
• additioneel: de website van de content-leverancier ontvangt via de Digibib API een lijst met digitale leermiddelen van de content-leverancier waar een leerling of docent toegang toe heeft.

Gebruikte protocollen

Voor het uitwisselen van informatie tussen de Digibib en de website van de content-leverancier worden twee verschillende situaties onderscheiden:

• De configuratie Hieronder wordt onder andere het onderhoud van de digitale leermiddelen in de catalogus gerekend en andere informatie die relatief weinig wijzigt.
• Het gebruik Dit is proces informatie. Deze informatieuitwisseling vindt plaats tijdens het gebruik van het digitale leermiddel door de leerling of docent.

De API maakt gebruik van standaard protocollen die in de praktijk veelvuldig worden gebruikt. Voor de configuratie is dit een interface op basis van de “OpenAPI Specification”. Voor het uitwisselen van informatie tijdens het gebruik wordt het “LTI-protocol” gebruikt.

OpenAPI Specification (Swagger)

Het onderhoud van de configuratie van de digitale leermiddelen wordt uitgevoerd door middel van calls die voldoen aan de OpenAPI Specification (OAS). De API van de Digibib is geïmplementeerd door middel van Swagger (swagger.io).

De OAS is een standaard die platformonafhankelijk is en ook eenvoudig te begrijpen door mensen. Swagger biedt tools om een client-library te maken voor een specifiek platform. Daarnaast worden er documentatie-, voorbeeld- en test-pagina’s aangeboden waardoor de realisatie van een koppeling wordt vereenvoudigt.

De calls worden gedaan op basis van een RESTful interface. Dit betekent dat er geen specifieke netwerkvereisten zijn en alles via ‘https’ wordt aangeboden.

Conceptversie van de API definitie

Learning Tools Interoperability (LTI 1.1)

De communicatie tussen het digitale leermiddel en de Digibib is geïmplementeerd op basis van de Learning Tools Interoperability (LTI). Dit is dé standaard voor het koppelen van Leerling Management Systemen aan leermiddelen.

Binnen LTI worden de volgende begrippen gedefinieerd:

• LTI Consumer Het systeem dat gebruik maakt van het digitale leermiddel in dit geval de Digibib.
• LTI Tool Provider Het systeem waarop het product staat. Dit is de website van derden met het digitale leermiddel.
• Course Dit is het onderdeel van het digitale leermiddel dat wordt afgenomen door de leerling of docent. Dit kan een heel digitale leermiddel zijn, maar ook een specifiek onderdeel van een digitaal leermiddel.
• User Dit is de leerling of docent die gebruik maakt van het digitale leermiddel.

Er zijn veel implementaties beschikbaar van LTI voor veel ontwikkelplatforms. Onder water maakt LTI gebruik van OpenAuth waardoor er ook aan LTI geen specifieke netwerk vereisten zijn verbonden. LTI 1.1 is de op dit moment meest gebruikte en ondersteunde versie. Daarom is voor de implementatie gekozen voor deze versie (en nog niet voor de 2.0 versie).