Platform Notification Service met LTI 1.3
Platform Notification Service LTI Standard creëert een nieuw kanaal voor externe cursustools om buiten een actieve gebruikerssessie in Brightspace® te communiceren, waardoor de mate van integratie tussen Externe cursustools en D2L® Brightspace® wordt verdiept.
Als de Platform Notification Service is ingeschakeld, kunnen externe cursustools toolhandlers registreren, bijwerken en verwijderen om meldingen te ontvangen en kan een melding over contextkopie worden geactiveerd om tools te informeren wanneer een cursuskopie heeft plaatsgevonden.
Handler-eindpunten voor Platform Notification Service
Tools kunnen handler-eindpunten registreren voor specifieke meldingstypen. Als reactie op bepaalde acties die binnen Brightspace® worden uitgevoerd, wordt een ondertekende JWT-payload geplaatst op het geregistreerde eindpunt met LTI-gegevens die relevant zijn voor het gegeven meldingstype.
Activering van Platform Notification Service
De Platform Notification Service-extensie moet worden ingeschakeld voor de toolintegratie voordat deze kan worden gebruikt. Het inschakelproces is vergelijkbaar met andere LTI-extensies die momenteel beschikbaar zijn. Deze nieuwe service kan worden ingeschakeld via dynamische registratie, API's of via de gebruikersinterface.
Beheerders kunnen de Platform Notification Service inschakelen bij registratie (Uitbreidbaarheid beheren) en implementatie (Externe cursustools). Melding over contextkopie moet ook worden ingeschakeld bij de implementatie van de tool. Hierdoor kunnen externe cursustools zich abonneren op meldingen van webhook-gebeurtenissen.
Raadpleeg het onderwerp Registratie, implementatie en koppelingen van tools voor meer informatie over het inschakelen van Platform Notification Service en Melding over contextkopie in Brightspace® tijdens zowel registratie als implementatie.
Registratie- en implementatie-API's
Registratie- en implementatie-API's zijn beschikbaar voor het maken en bijwerken van integraties die gebruikmaken van de Platform Notification Service. De Platform Notification Service moet worden ingeschakeld op het registratieniveau en implementatieniveau, en vervolgens moeten afzonderlijke typen meldingen eveneens worden ingeschakeld op implementatieniveau.
Dynamische registratie
De Platform Notification Service kan worden ingeschakeld via dynamische registratie. De typen meldingen die door het platform worden ondersteund, zijn opgenomen in de claim voor platformconfiguratie. Naar verwachting zullen er nieuwe kennisgevingen aan deze claim worden toegevoegd, omdat er extra typen kennisgevingen aan deze service worden toegevoegd.
Functies
Zodra de Platform Notification Service is ingeschakeld, kunnen tools een handler registreren en bijwerken om berichten te ontvangen.
Kennisgevingen worden naar de geregistreerde handler verzonden volgens de specifieke kennisgevingsdefinities die hieronder worden beschreven. Elk type melding is bedoeld voor een specifiek gebruiksscenario.
Handler-API
De Platform Notification Service biedt een API waarmee tools een lijst van handlers die momenteel bestaan voor die integratie kunnen ophalen (GET) en die updates voor die handlers kunnen plaatsen (PUT). Met de PUT API kunnen nieuwe handlers worden ingesteld, bestaande handlers worden bijgewerkt of handlers worden verwijderd. Het API-eindpunt wordt gedefinieerd in de LTI-launch onder de Platform Notification Service-claim en heeft de volgende indeling.
/d2l/api/lti/pns/[versie]/handlers/deployment/[DeploymentID]
De volgende validatie vindt plaats op de geregistreerde handler. Er moet aan deze criteria worden voldaan voordat een handler wordt geregistreerd:
- gebruik https
- een geldige URL
- Moet het registratiedomein van de tool als hoofddomein hebben of overeenkomen met een geregistreerde omleidings-URL.
Ondersteunde kennisgevingen
De lijst met ondersteunde kennisgevingen wordt weergegeven in de startclaim. De eerste release van de Platform Notification Service heeft de Melding over contextkopie. Er is ook een testmelding die op verzoek beschikbaar kan worden gesteld om een integratie te testen zonder gebruik te maken van specifieke Brightspace® -gebeurtenissen.
De testmelding ziet er als volgt uit:
"notice_types_supported":[
0:"LtiContextCopyNotice"
Melding over contextkopie
De Melding over contextkopie informeert de tool wanneer een gebeurtenis over een kopie van een cursus plaatsvindt binnen de deelregels van de tool voor de implementatie. De melding bevat de oorspronkelijke cursuscontext-id en de bestemmingscursus-id. De naam van de bestemmingscursus en de cursusbeschrijving worden ook opgenomen als de instelling Informatie organisatie-eenheid is ingeschakeld voor die implementatie.
De oorspronkelijke cursus hoeft niet te worden opgenomen in de deelregels van de tool om een kennisgeving te verzenden. Alleen de bestemmingscursus-id moet in de deelregels van de tool staan.
Bij elk kopieerproces van een cursus (bijvoorbeeld handmatig, bulk of API) wordt een contextkopieergebeurtenis gemaakt die naar de tool moet worden verzonden.
Berichtindeling
Tools ontvangen een ondertekende JSON-payload. Deze payload is een matrix van een of meer meldingen en volgt de 1EdTech-standaard.
|
Opmerking: Voor meer informatie over de 1Edtech-standaard raadpleegt u de website 1Edtech. |
Elk bericht bevat een unieke id en tijd. De id en tijd zijn specifiek voor de meldingsgebeurtenis (bijvoorbeeld Cursuskopie of Indieningsgebeurtenis); en de JSON-informatie is uniek voor wanneer de melding wordt verzonden, niet gerelateerd aan de inhoud van de melding.
Logica voor opnieuw proberen
Nieuwe pogingen worden niet ondersteund voor de eerste release van deze service. Nieuwe pogingen zijn momenteel niet vereist door de standaard.
Meldingen stoppen
De volgende opties zijn beschikbaar om te stoppen met het verzenden van meldingen naar de tool. De eerste drie opties kunnen worden uitgevoerd via Brightspace® of per API door een beheerder:
- Schakel het specifieke meldingstype uit bij de implementatie
- Platform Notification Service uitschakelen bij implementatie: Hiermee worden alle typen meldingen voor die implementatie uitgeschakeld.
- Platform Notification Service uitschakelen bij de registratie: Hiermee schakelt u de Platform Notification Service en alle typen meldingen uit voor alle implementaties onder die registratie.
- Verwijder de berichtenhandler(s) voor die toolintegratie: Deze optie kan alleen worden uitgevoerd door de tool.
Gebruikerservaring
Platform Notification Service is een platform-naar-tool service. Deze kennisgevingen zijn niet rechtstreeks bedoeld voor cursisten, instructeurs of beheerders. Door deze meldingen te ontvangen, kunnen tools het serviceniveau van hun integraties verbeteren. De Melding over contextkopie biedt cursisten, instructeurs en beheerders als voordeel dat LTI-inhoud betrouwbaarder is na het kopiëren van de cursus. Met de informatie in Contextkopie kunnen tools de gebeurtenissen van de cursuskopie op het platform bekijken, waardoor problemen met het kopiëren van cursussen worden vermeden.