lectoraIntegrer Lectora

OPPSETT · CANVAS-ADMINISTRATOR

Hvordan installerer jeg Lectora i Canvas med LTI 1.3?

Denne veiledningen er for Canvas-administratorer som installerer Lectora institusjonsbredt via LTI 1.3 Dynamic Registration — omtrent femten minutters arbeid som ender med at hver underviser i din Canvas-instans starter Lectora direkte fra et emnes venstre navigasjonsmeny, uten per-lærer-tokener å holde rede på. Installasjonen oppretter to Canvas Developer Keys: én LTI Registration-nøkkel (opprettes automatisk av Dynamic Registration) og en separat API-nøkkel for Canvas REST API-tilgang som lar Lectora lese innleveringer og skrive karakterer tilbake. Begge er nødvendige — Canvas' LTI-nøkler kan ikke utføre OAuth authorization_code-grant-typen Lectora trenger for API-tilgang, så API-nøkkelen er en separat nøkkel du oppretter manuelt før du bekrefter LTI-registreringen. Hvis du bare vil at én underviser skal prøve Lectora på sine egne emner før IT involveres, er PAT-hurtigstarten den lettere veien. For utrullinger med flere undervisere er LTI 1.3 det eneste kompatible alternativet — Canvas' API-policy begrenser personlige tilgangstokener til individuell bruk.

Hvorfor LTI 1.3 (og ikke per-lærer-tokener)?

For utrullinger med flere undervisere er LTI 1.3 den eneste kompatible integrasjonsveien. Canvas API-policy og Canvas' dokumentasjon for manuell token-generering begrenser personlige tilgangstokener til personlig, enkeltbrukerbruk; en tredjepartsapp som ber hver underviser om å generere og levere et token er ikke en kompatibel integrasjon.

I tillegg til kompatibilitet gir LTI-installasjonen deg ettklikks onboarding for undervisere (underviserne åpner bare Lectora fra et emnes venstre navigasjon, uten registrering eller token å kopiere), sentralisert livssykluskontroll (slå av LTI Developer Key og Lectora slutter å virke overalt umiddelbart), stabil identitet (Canvas utsteder signerte JWT-er ved hver oppstart, uten langvarige hemmeligheter som kan lekke eller bli glemt når en underviser slutter), og én institusjonsnivå OAuth Developer Key — separat fra LTI-nøkkelen, opprettes under installasjonen — som håndterer Lectoras Canvas API-tilgang for hver underviser på ett sted, slik at karakter-tilbakeskriving fungerer uten per-lærer-tokener.

Hva blir installert?

To Canvas Developer Keys med to ulike roller. API-nøkkelen lar Lectora kalle Canvas REST API på vegne av hver underviser — lese innleveringer, skrive karakterer tilbake — ved hjelp av OAuth 2.0 authorization_code-grant. Du oppretter den manuelt i Steg 2 ved å klikke + Developer Key → API Key og kopiere ut Client ID og Secret. LTI Registration-nøkkelen håndterer «klikk Lectora i emnesidemenyen og bli logget inn» — den implementerer LTI 1.3-oppstartshandshaket, signerte JWT-er, og plasseringen i emnenavigasjonen. Canvas oppretter den automatisk når du kjører Dynamic Registration i Steg 3 (+ Developer Key → LTI Registration).

Begge nøkler er nødvendige. Canvas' LTI-nøkler kan ikke utføre OAuth authorization_code-grant, så API-nøkkelen kan ikke erstattes av LTI Registration — de er to komplementære nøkler for to ulike protokoller. Det eneste manuelle limet noe sted i flyten er API-nøkkelens Client ID og Secret fra Steg 2 inn i Dynamic Registration-bekreftelsesiframen i Steg 4. Ingen JSON, ingen konfigurasjonsfiler, ingen manuell nøkkelgenerering.

Én stille nyttig detalj: når du kjører Dynamic Registration på Admin-nivå (standard for institusjonsbrede installasjoner), oppretter Canvas automatisk External App-oppføringen for Lectora på den kontoen også. Når du er ferdig med Steg 5, er Lectora tilgjengelig i hvert emne under kontoen du registrerte på. Det manuelle per-emne installasjonssteget er bare nødvendig for smale piloter med ett emne — se Steg 6 for verifisering og den smale utrullings-veien.

Hva trenger du før du starter?

Tre ting. Canvas-administratortilgang på Site Admin- eller rotkonto-nivå — uten det ser du ikke Developer Keys i admin-menyen. Lectora-URL-en din — for de fleste institusjoner er dette den hostede produksjonsappen på https://lectora.app, som er den anbefalte veien: vi drifter, vi oppdaterer, og IT-en din slipper å operere noe selv. Institusjoner med strenge krav til datalokalisering kan i stedet selv-hoste Lectora (det er åpen kildekode) på sitt eget domene; i så fall, bytt ut lectora.app med ditt eget domene gjennom hele veiledningen. Registreringsendepunktet er alltid Lectora-URL-en din pluss /api/lti/register. Og nettverkstilgang — Canvas må kunne nå Lectora-URL-en over HTTPS, så hvis du piloterer mot en Canvas-instans bak en bedriftsbrannmur, avklar dette med nettverksteamet ditt først.

En merknad om de to Developer Keys du skal opprette. LTI Registration-Developer Key opprettes automatisk når du fullfører Dynamic Registration i Steg 3 — den håndterer underviser-oppstart fra emnesidemenyen. En separat API Developer Key for Canvas REST API OAuth opprettes manuelt i Steg 2 under og limes inn på Dynamic Registration-bekreftelsessiden — den lar Lectora lese innleveringer og skrive karakterer tilbake til Canvas som underviseren som startet Lectora. API-nøkkelen er en separat nøkkel fordi Canvas' LTI-nøkler ikke støtter authorization_code OAuth-grant; dette er en begrensning fra Canvas, ikke fra Lectora. Uten API-nøkkelen avviser Canvas Dynamic Registration-innsendingen, så vi oppretter den først.

Steg 1 — Åpne Developer Keys

  1. I Canvas, klikk Admin i venstre sidemeny.
  2. Velg Developer Keys fra admin-menyen.

Du lander på Developer Keys-listen — vanligvis tom for nye installasjoner, eller med eventuelle eksisterende tredjepartsverktøy.

Steg 1 — Canvas Admin-sidemeny → Developer Keys

Steg 2 — Opprett Canvas API Developer Key

En separat Developer Key — atskilt fra LTI Registration-nøkkelen — som lar Lectora kalle Canvas API for karakter-tilbakeskriving. Dynamic Registration-bekreftelsesiframen i Steg 4 har obligatoriske felt for denne nøkkelens Client ID og Secret, så opprett den nå slik at du har verdiene klare.

  1. På Developer Keys-siden, klikk + Developer Key øverst til høyre.
  2. Velg + API Key fra nedtrekkslisten (det øverste av tre alternativer).
  3. Fyll inn Key Settings-skjemaet. La resten stå som standard:
    • Key NameLectora API Access
    • Owner Email — administrator-e-posten din (Canvas sender rotasjons- og vedlikeholdsvarsler hit)
    • Redirect URIs — lim inn Lectora OAuth-callback-URL-en (under)
    • Icon URLhttps://lectora.app/icon.svg (eller ditt selv-hostede Lectora-domene pluss /icon.svg)
  4. Sett Enforce Scopes til OFF foreløpig. Nyere Canvas-instanser har dette på som standard, som krever at du forhåndsvelger hver scope Lectora trenger — enklere å verifisere installasjonen ende-til-ende først, så stramme inn.
  5. Klikk Save.
  6. På Developer Keys-listen, slå den nye nøkkelens State til ON.
  7. Kopier Client ID fra Details-kolonnen (en lang numerisk streng som 10000000000040).
  8. Klikk Show Key for å vise Secret, kopier den, og lim både Client ID og Secret inn i en midlertidig notatblokk. Du trenger dem i Steg 4.

Når karaktersetting ende-til-ende er verifisert (Steg 7), kom tilbake hit og slå Enforce Scopes på. Velg bare scopes Lectora faktisk trenger — courses, assignments, submissions, users, enrollments, files, rubrics. Et lekket API-token med ubegrensede scopes er mye farligere enn et lekket scope-begrenset token.

OAuth-callback-URL for hostet produksjon — lim denne inn i API-nøkkelens Redirect URIs-felt. Selv-hostende bytter ut med eget Lectora-domene.

https://lectora.app/api/auth/canvas/callback

Steg 2 — + Developer Key-nedtrekksliste, API Key-alternativet uthevet

Steg 2 — Key Settings-skjema, felt fylt inn

Steg 2 — Show Key-modal. Canvas viser hemmeligheten kun én gang; kopier den nå.

Steg 3 — Start en Dynamic Registration

Med API Key-legitimasjonen trygt kopiert er du klar til å registrere Lectora som et LTI-verktøy.

  1. Tilbake på Developer Keys-listen, klikk + Developer Key øverst til høyre igjen.
  2. Velg + LTI Registration fra nedtrekkslisten (det tredje alternativet).
  3. I modalen som åpnes, velg Dynamic Registration (det første alternativet).
  4. Oppgi Lectoras registreringsendepunkt i URL-feltet (under).
  5. Klikk Continue.

Registrerings-URL for hostet produksjon. Selv-hostende bytter ut med eget Lectora-domene.

https://lectora.app/api/lti/register

Steg 3 — + Developer Key-nedtrekksliste igjen, denne gangen velg LTI Registration

Steg 3 — Dynamic Registration-dialog med URL-en oppgitt

Steg 4 — Bekreft installasjonen

Canvas åpner Lectoras bekreftelsesside i en iframe. Den viser Canvas-instansen Lectora oppdaget, plasseringene Lectora vil be om (emnenavigasjon), og to obligatoriske OAuth-legitimasjonsfelt.

  1. Lim inn Client ID du kopierte i Steg 2 i OAuth Client ID-feltet.
  2. Lim inn Secret du kopierte i Steg 2 i OAuth Client Secret-feltet.
  3. Gjennomgå plasseringene (course navigation skal være avkrysset).
  4. Klikk Confirm Installation.

Iframen lukkes automatisk når registreringen lykkes.

Steg 4 — Bekreftelsesside med OAuth Client ID og Secret limt inn fra Steg 2

Steg 5 — Aktiver LTI Developer Key

Tilbake på Developer Keys-listen ser du nå to Lectora-rader — API Key fra Steg 2 (allerede ON) og den nye LTI Registration-nøkkelen (starter OFF).

  1. Finn den nye LTI Registration-raden.
  2. Slå dens State til ON — nye nøkler starter OFF.
  3. Kopier Client ID for LTI Registration-nøkkelen fra Details-kolonnen. Du trenger den i Steg 6 (et langt tall, typisk 10000000000123 eller lignende).

Steg 5 — Begge nøkler ON. To nøkler, begge grønne — installasjonen er ferdig på Canvas-siden.

Steg 6 — Verifiser at Lectora er installert (og smal eventuelt ned omfanget)

Gode nyheter: verktøyet er allerede installert. Da du kjørte Dynamic Registration i Steg 3 på Admin-nivå, opprettet Canvas automatisk en External App-oppføring for Lectora, og å slå LTI-nøkkelen ON i Steg 5 aktiverte det i hvert emne under den kontoen.

  1. Gå til Admin → Settings → Apps-fanen → View App Configurations.
  2. Se etter en Lectora-rad i listen — det bekrefter at installasjonen på kontonivå landet.

Hvis du kjørte Dynamic Registration på rotkontoen, kan hvert emne i Canvas-instansen din nå vise Lectora — hopp til Steg 7 for å verifisere oppstart fra underviser-siden.

Valgfritt — smal utrullings-vei. Bruk denne bare når du vil pilotere Lectora med én avdeling, skole eller ett emne før bredere utrulling. Hvis verktøyet allerede er installert kontobredt, hopp over dette steget; Lectora er allerede tilgjengelig overalt.

  1. Åpne emnet → SettingsApps-fanen → View App Configurations.
  2. Klikk + App øverst til høyre.
  3. Sett Configuration Type til By Client ID.
  4. Lim inn LTI Registration-nøkkelens Client ID fra Steg 5.
  5. Klikk Submit, og bekreft når Canvas spør Tool found, install?.

Sjelden fallback. Hvis Lectora ikke vises i Admin → Settings → Apps etter Steg 5, har auto-installasjonen ikke skjedd. Installer manuelt med samme flyt som den smale utrullings-veien over, men på admin-nivå (Admin → Settings → Apps → + App → By Client ID → lim inn → Submit).

Steg 6 (kun smal utrulling) — per-emne installasjon via By Client ID

Steg 6 fallback — dra Lectora fra skjult til synlig i emnets navigasjonsrekkefølge

Steg 7 — Verifiser at det fungerer

Raskest ende-til-ende-test:

  1. Åpne et emne der Lectora er installert.
  2. Klikk Lectora i venstre sidemeny.
  3. Bekreft at Lectora-emnevisningen lastes inn i Canvas med emnene dine listet.

Hvis du kom hit, er installasjonen ferdig. Undervisere i ethvert installert emne kan nå bruke Lectora uten ekstra oppsett — send dem en enkel beskjed: «Åpne et emne der Lectora er installert og klikk Lectora i venstre sidemeny; du blir logget inn automatisk.»

Steg 7 — vellykket oppstart fra en undervisers perspektiv

Oppdatere eller fjerne installasjonen

For å endre Lectoras LTI-konfigurasjon (for eksempel for å oppdatere plasseringer eller scopes etter en Lectora-utgivelse), gå til Admin → Developer Keys, klikk på blyantredigeringsikonet på LTI Registration-nøkkelen, oppgi registrerings-URL-en på nytt, og klikk Save. Canvas henter konfigurasjonen på nytt; eksisterende emneinstallasjoner fortsetter å fungere uten endringer. For å rotere API-nøkkelens hemmelighet, klikk Show Key på API Key-raden for å generere en ny hemmelighet, og kjør deretter Dynamic Registration på nytt med den nye verdien (eller la Lectora-administratoren din oppdatere den lagrede legitimasjonen direkte).

For å avinstallere fullstendig må du fjerne begge nøklene. Enten fjern External App fra hvert emne (Course Settings → Apps → Lectora → søppelbøtteikon), eller slett LTI Registration-nøkkelen (Admin → Developer Keys → søppelbøtteikon på Lectora LTI-raden) for å deaktivere Lectora-oppstart overalt på én gang. Slett deretter også API-nøkkelen (søppelbøtteikon på Lectora API Access-raden) slik at Lectora ikke lenger kan kalle Canvas API. Å slå en av nøklene OFF i stedet for å slette den er et tryggere reversibelt alternativ hvis du er usikker.

Omtrent 15 minutter hvis du har Canvas-administratortilgang og en Lectora-URL klar — fem for å opprette API Developer Key (Steg 2), fem for Dynamic Registration og å slå LTI-nøkkelen på (Steg 3–5), og fem for å gjøre Lectora tilgjengelig i emner og verifisere (Steg 6–7). Den lengste forsinkelsen er vanligvis å avtale tid med Canvas-rotkonto-administratoren, ikke selve installasjonen.