Praktische toepassingen van de API
Zeven dingen die je met de Linqur API automatiseert, en de endpoints die je daarvoor nodig hebt.
De Linqur API heeft 40 endpoints in tien groepen. Deze pagina deelt ze in per taak: wat je gedaan wilt krijgen, en welke aanroepen dat doen. Elke aanroep heeft een API-sleutel nodig in de header Access-Token; API-documentatie legt authenticatie, de testversie v0 en de limieten uit.
Cursussen en SCORM-pakketten aanmaken en bijwerken
Publiceer je een nieuwe cursus of een nieuwe versie van een pakket in je authoringtool, dan kan je build-pipeline die in Linqur zetten zonder dat iemand inlogt. Maak de cursus aan met GET /course/add, upload het pakket met POST /course/learningobject/scorm/add en stuur later een nieuwe versie met POST /course/learningobject/scorm/update. GET /course/learningobject/list vertelt je welk leerobject-id je moet bijwerken. De velden voor beoordeling en weergave in de upload zijn dezelfde als de SCORM-instellingen in de interface.
Endpoints: API: cursussen en API: learning objects.
Per klant een LTI-tool aanmaken
Krijgt elke klant een eigen LTI-tool voor dezelfde cursus, bijvoorbeeld om registraties per klant te tellen of een andere inschrijfperiode in te stellen, dan kun je die tools aanmaken vanuit je CRM of ordersysteem. GET /course/tool/add maakt de tool aan met de LTI-versie, de publicatiemodus, het maximale aantal gebruikers en de synchronisatie-instellingen. GET /course/tool/list geeft de launch-URL, de registratie-URL en de secret die je naar de klant stuurt; ga daar vertrouwelijk mee om. Wijzig een tool met GET /course/tool/update en verwijder hem met GET /course/tool/delete.
Endpoints: API: LTI-tools.
Gebruikers en registraties uitlezen voor rapportages
Voor je eigen dashboards of een maandrapport haal je de cijfers op in plaats van ze met de hand te exporteren. GET /course/list geeft elke cursus met de aantallen registraties per kanaal (LTI, sign-up URL, SCORM Proxy). GET /course/lti/registrations_by_day en GET /course/lti/registrations_sum_by_course geven LTI-registraties per dag en per cursus voor een periode. GET /user/list geeft de gebruikers van een LTI-tool met hun laatste cijfer en laatste toegang, GET /member/list elk uniek LTI-lid op het platform, en GET /magic/user/list de gebruikers die zich via een sign-up URL hebben aangemeld, met hun cursuscijfer.
Endpoints: API: analytics, API: gebruikers, API: members en API: sign-up URL’s (magic).
Sign-up URL’s en inschrijvingen vanuit een webshop of CRM
Een klant koopt een cursus in je webshop en krijgt direct toegang. Maak eenmalig een sign-up URL voor de cursus met POST /magic/url/add; die geeft de cursushash terug. Na een aankoop maakt POST /magic/user/enrol de gebruiker aan als die nog niet bestaat en schrijft hem in met die hash, en POST /magic/login geeft een loginlink terug of mailt die als mail true is. Om de toegang te beëindigen haalt POST /user/unenrol de gebruiker uit de cursus, eventueel met een reset van de voortgang. POST /course/grade zet of herstelt een handmatig cursuscijfer, bijvoorbeeld na een examen buiten Linqur. Voor een WooCommerce-shop is er een kant-en-klare plug-in; lees WooCommerce aan je LMS koppelen.
Endpoints: API: sign-up URL’s (magic), API: gebruikers en API: cursussen.
Bestanden in de bestandsopslag bijwerken
De bestandsopslag bevat bestanden die je in meerdere activiteiten hergebruikt, zoals een SCORM-pakket dat aan meer dan één cursus is gekoppeld. POST /file/add uploadt een bestand als base64-inhoud met een titel, referentie en versie, POST /file/update vervangt de inhoud en metadata, GET /file/list geeft elk bijgehouden bestand met zijn revisie, en POST /file/delete verwijdert er een. Hoe activiteiten een nieuwe versie van een gekoppeld bestand gebruiken, staat in Bestanden beheren in de bestandsopslag.
Endpoints: API: bestanden.
SCORM Proxy
Een SCORM Proxy-wrapper is een klein SCORM-pakket dat in het LMS van een klant draait en de inhoud afspeelt vanaf je platform. POST /scormproxy/add maakt een wrapper voor een cursus of activiteit, met een inschrijfperiode, een maximaal aantal gebruikers en toegestane domeinen, en geeft de downloadlinks per SCORM-versie terug. GET /scormproxy/list toont de wrappers met hun registraties, POST /scormproxy/update wijzigt er een en POST /scormproxy/delete zet hem uit. GET /scormproxy/results geeft de CMI-data per registratie, zodat je voltooiing en scores vanuit je eigen systeem kunt controleren.
Endpoints: API: SCORM Proxy.
Tokens beheren
Praten meerdere systemen met je platform, geef dan elk systeem een eigen token, zodat je er één kunt intrekken zonder de andere te raken. GET /token/list toont de tokens met hun laatste toegang, GET /token/add maakt er een aan en GET /token/delete verwijdert er een. Een token verwijderen stopt elke koppeling die dat token gebruikt.
Endpoints: API: tokens.
Andersom: webhooks
De API is voor aanroepen van jouw systeem naar Linqur. Moet Linqur juist jouw systeem een seintje geven, bijvoorbeeld als een cursist een cursus afrondt, gebruik dan webhooks. Voor automatiseringen zonder code: lees hoe je e-learning automatiseert met n8n en Linqur of met Make en Linqur.