I Canvas kan du skapa två typer av utvecklarnycklar: LTI-nycklar och API-nycklar. De här instruktionerna är för LTI-utvecklarnycklar. Vill du skapa API-utvecklarnycklar? Gå till Canvas API-utvecklarnycklar.

Ally använder LTI för att integrera med din lärplattform (LMS). LTI är en standard som tagits fram av IMS Global för säkra och smidiga integreringar.

Standarden gör det möjligt för användare att komma åt Ally utan att lämna Canvas. Slipp logga in på flera webbplatser: LTI möjliggör ett säkert utbyte av information för en sammanhängande upplevelse för dina användare.

Det finns två versioner av LTI: v1.1 och v1.3. Varje version kräver olika konfigurationssteg. Den aktuella versionen är LTI v1.3. Den största skillnaden jämfört med tidigare versioner är den uppgraderade säkerhetsmodellen baserad på OAuth2, OpenID Connect och JSON Web Tokens.

Ally flyttar till LTI 1.3 för att dra nytta av den uppgraderade säkerhetsmodellen.

Vad betyder detta för dig? Ingenting, om Ally är nytt för dig. Vi tar hand om konfigurationen av Ally-integreringen med dig. Men om du redan har integrerat Ally med din LMS måste du omkonfigurera din integrering med LTI 1.3.

Omkonfigurera din Ally-integrering med LTI 1.3

Ett typiskt lärosäte skulle ha följande tre Ally-verktyg tillgängliga i rotkontot:

Varje verktyg har en LTI-utvecklarnyckel och program.

Du måste konfigurera varje verktyg med denna process:

  1. Skapa en LTI 1.3-utvecklarnyckel för varje verktyg.
  2. Konfigurera varje verktygsprogram med utvecklarnyckelns information.
  3. Skicka utvecklarnyckelns ID och LTI-distributions-ID:t för varje verktyg till Ally för konfiguration. 
  4. Ta bort LTI 1.1-konfigurationen.

    Gör det här steget sist för en smidig övergång utan avbrott.

Skapa en LTI-utvecklarnyckel för varje verktyg

  1. Gå till Canvas-instansens rotkonto och sedan till Utvecklarnycklar.
  2. Välj knappen + Utvecklarnyckel och välj LTI-nyckel.
    Developer Keys page on a Canvas environment. The + Developer Key button is expanded showing the LTI Key option.
    Skärmen Konfigurera nyckelinställningar öppnas.
  3. Välj menyn Metod och välj Klistra in JSON.
    The Method menu opened with the Paste JSON open highlighted.
  4. Öppna URL för det LTI-verktyg du skapar nyckeln för för att generera JSON-konfiguration. Ersätt [AllyEnvironment] med information om den miljö där ditt lärosäte har sin värd. 
    • Lärosätesrapport: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/institution
    • Klientkonfiguration: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/config
    • Kurstillgänglighetsrapport: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/course
  5. Kopiera informationen på den webbsida som öppnas.
  6. Kopiera och klistra in länken i fältet Dirigera om URI:er. Ersätt [AllyEnvironment] med information om den miljö där ditt lärosäte har sin värd. 
    • https://<AllyEnvironment>/api/v2/auth/lti/1.3/callback
  7. Ange ett nyckelnamn.

    Inkludera verktygets namn och ange LTI 1.3 i varje. Till exempel: Ally-lärosätesrapport LTI 1.3, Ally-kurstillgänglighetsrapport LTI 1.3 och Ally-klientkonfiguration LTI 1.3.

  8. Klicka på Spara. Den nya nyckeln läggs till på sidan Utvecklarnycklar och är Av som standard.
  9. Aktivera den nya nyckeln.
  10. Kopiera nyckelns ID-nummer och hemligheten i kolumnen Detaljer. Nyckelns ID-nummer är ditt unika klient-ID.

Ally-miljö för din region

Använd informationen för den Ally-miljö där ditt lärosäte har sin värd.

  • Datacenter i USA: prod.ally.ac
  • Datacenter i Kanada: prod-ca-central-1.ally.ac
  • Datacenter i Europa: prod-eu-central-1.ally.ac
  • Datacenter i Singapore: prod-ap-southeast-1.ally.ac
  • Datacenter i Australien: prod-ap-southeast-2.ally.ac

Konfigurera verktyget

Följ de här stegen för verktygen Lärosätesrapport, Klientkonfiguration och Kurstillgänglighetsrapport.

  1. Välj Inställningar från rotkontot.
  2. Välj Appar och Visa appkonfiguration.
  3. Välj knappen Lägg till en app.
  4. Öppna menyn Konfigurationstyp och välj Efter klient-ID.
  5. Klistra in det ID-nummer för klientnyckeln som du gav till Allys supportteam i fältet Klient-ID.
  6. Klicka på Skicka.
  7. Välj Installera.
  8. Kopiera LTI-distributions-ID:t för varje rapportverktyg.

En ny länk för verktyget visas i den vänstra navigeringslistan med länkar. När Ally har konfigurerat verktyget i Ally-systemet kan du komma åt verktyget via denna länk.

Skicka nyckel-ID:t till Ally

Gå till Behind the Blackboard och skapa ett supportärende med denna information, så att Ally-teamet kan konfigureraverktygen i Ally-systemet.

  • Utvecklarnyckel-ID för varje verktyg
  • LTI-distributions-ID för varje verktyg
  • Gör en förfrågan om att konfigurera LTI 1.3-verktyg

Utvecklarnyckeln för min lärosätesrapport är till exempel: #00000000000000000. Distributions-ID:t för min lärosätesrapport är: 0000:00c00dc0ec00c00cdc000fced. Konfigurera min LTI 1.3-rapport.

Du kan ha separata rapporter för de olika underkontona i din Canvas-miljö. Kopiera distributions-ID:t för underkontot och lägg till den informationen i supportärendet.

Uppdatera Ally-fragmentet i Canvas-temat

När Ally-lärosätesrapporten har konfigurerats med LTI 1.3 ska du uppdatera Ally-fragmentet i Canvas-temat. Det måste finnas ett lti13Id-fält som motsvarar klient-ID:t för LTI 1.3-lärosätesrapporten (Ally-verktygs-ID) som lagts till.

  1. Som Canvas-administratör går du till Admin och väljer Konto.
  2. Välj Teman.
  3. Peka på det aktiva temat och välj Öppna i temaredigerare.
  4. Välj fliken Ladda upp.
  5. Lägg till egenskapen ltil3Id i Javascript-fragmentet. Byt ut [InstitutionalReportDeveloperKeyID] med utvecklarnyckel-ID:t för din lärosätesrapport.

    window.ALLY_CFG = {
     'baseUrl': 'https://prod.ally.ac',
     'clientId': 00000,
     'lti13Id': '<YourInstitutionalReportDeveloperKeyID>'
    };
    $.getScript(ALLY_CFG.baseUrl + '/integration/canvas/ally.js');

  6. Välj Tillämpa tema.