In Canvas können Sie zwei Arten von Entwicklerschlüsseln erstellen: LTI-Schlüssel und API-Schlüssel. Diese Anweisungen gelten für LTI-Entwicklerschlüssel. Möchten Sie neue API-Entwicklerschlüssel erstellen? Wechseln Sie zu Canvas API-Entwicklerschlüssel.

Ally verwendet LTI für die Integration in Ihr Learning Management System (LMS). LTI ist ein von IMS Global entwickelter Standard für sichere und nahtlose Integrationen.

Der Standard ermöglicht Benutzern den Zugriff auf Ally, ohne Canvas zu verlassen. Sie müssen sich nicht bei mehreren Websites anmelden: LTI ermöglicht einen sicheren Austausch von Informationen und bietet so eine einheitliche Erfahrung für Ihre Benutzer.

Es gibt zwei Versionen von LTI: Version 1.1 und Version 1.3. Für jede Version sind unterschiedliche Konfigurationsschritte erforderlich. Die aktuelle LTI-Version ist Version 1.3. Der größte Unterschied zu früheren Versionen ist das aktualisierte Sicherheitsmodell, das auf OAuth2-, OpenID Connect und JSON Web Tokens basiert.

Ally wechselt zu LTI 1.3, um das aktualisierte Sicherheitsmodell zu nutzen.

Was bedeutet das für Sie? Wenn Sie Ally noch nicht nutzen, nichts. Wir führen die Einrichtung der Ally-Integration mit Ihnen durch. Wenn Sie jedoch Ally bereits in Ihr LMS integriert haben, müssen Sie Ihre Integration mit LTI 1.3 neu konfigurieren.

Konfigurieren Sie Ihre Ally-Integration mit LTI 1.3 neu.

Bei einer typischen Institution stehen im Root-Konto diese drei Ally-Tools zur Verfügung:

Jedes Tool verfügt über einen LTI-Entwicklerschlüssel und eine entsprechende Anwendung.

Sie müssen jedes Tool konfigurieren, indem Sie das folgende Verfahren befolgen:

  1. Erstellen Sie einen LTI 1.3-Entwicklerschlüssel für jedes Tool.
  2. Richten Sie jede Tool-Anwendung mit den Entwicklerschlüsselinformationen ein.
  3. Senden Sie die ID des Entwicklerschlüssels und die LTI-Bereitstellungs-ID für jedes Tool zur Konfiguration an Ally. 
  4. Entfernen Sie die LTI 1.1-Konfiguration.

    Führen Sie diesen Schritt zuletzt aus, um eine nahtlose Umstellung ohne Unterbrechungen zu ermöglichen.

LTI-Entwicklerschlüssel für jedes Tool erstellen

  1. Gehen Sie zum Root-Konto der Canvas-Instanz und rufen Sie Developer keys (Entwicklerschlüssel) auf.
  2. Wählen Sie die Schaltfläche + Developer Key (Entwicklerschlüssel) und anschließend LTI Key (LTI-Schlüssel) aus.
    Developer Keys page on a Canvas environment. The + Developer Key button is expanded showing the LTI Key option.
    Der Bildschirm zum Konfigurieren der Schlüsseleinstellungen wird geöffnet.
  3. Wählen Sie das Menü Method (Methode) und anschließend Paste JSON (JSON einfügen) aus.
    The Method menu opened with the Paste JSON open highlighted.
  4. Öffnen Sie die URL für das LTI-Tool, für das Sie den Schlüssel erstellen, um die JSON-Konfiguration zu generieren. Ersetzen Sie [AllyEnvironment]durch die Informationen zur Umgebung, in der Ihre Institution gehostet wird. 
    • Institutionsbericht: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/institution
    • Client-Konfiguration: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/config
    • Bericht zur Kursbarrierefreiheit: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/course
  5. Kopieren Sie die Informationen von der Webseite, die geöffnet wird.
  6. Kopieren Sie diesen Link und fügen Sie ihn in das Feld für Umleitungs-URIs ein. Ersetzen Sie [AllyEnvironment]durch die Informationen zur Umgebung, in der Ihre Institution gehostet wird. 
    • https://<AllyEnvironment>/api/v2/auth/lti/1.3/callback
  7. Geben Sie einen Schlüsselnamen an.

    Fügen Sie den Namen des Tools und LTI 1.3 ein. Beispiel: Ally-Institutionsbericht LTI 1.3, Ally-Bericht zur Kursbarrierefreiheit LTI 1.3 und Ally-Client-Konfiguration LTI 1.3.

  8. Wählen Sie Speichern. Der neue Schlüssel wird zur Seite mit den Entwicklerschlüsseln hinzugefügt und ist standardmäßig Deaktiviert.
  9. Aktivieren Sie den neuen Schlüssel.
  10. Kopieren Sie die Schlüssel-ID-Nummer und den Geheimschlüssel aus der Spalte Details. Diese Schlüssel-ID-Nummer ist Ihre eindeutige Client-ID.

Ally-Umgebung für Ihre Region

Verwenden Sie die Informationen für die Ally-Umgebung, in der Ihre Institution gehostet wird.

  • US-Rechenzentrum: prod.ally.ac
  • Kanadisches Rechenzentrum: prod-ca-central-1.ally.ac
  • Europäisches Rechenzentrum: prod-eu-central-1.ally.ac
  • Singapur-Rechenzentrum: prod-ap-southeast-1.ally.ac
  • Australisches Rechenzentrum: prod-ap-southeast-2.ally.ac

Tool einrichten

Befolgen Sie diese Schritte für die Tools „Institutionsbericht“, „Client-Konfiguration“ und „Bericht zur Kursbarrierefreiheit“.

  1. Wählen Sie im Root-Konto die Option Settings (Einstellungen) aus.
  2. Wählen Sie Apps und View App Configuration (App-Konfiguration anzeigen) aus.
  3. Wählen Sie die Schaltfläche zum Hinzufügen einer App aus.
  4. Wählen Sie im Menü Configuration Type (Konfigurationstyp) die Option By Client ID (Nach Client-ID) aus.
  5. Fügen Sie die ID-Nummer des Clientschlüssels, die Sie dem Ally-Support-Team mitgeteilt haben , in das Feld Client-ID ein.
  6. Wählen Sie Senden aus.
  7. Wählen Sie Installieren aus.
  8. Kopieren Sie die LTI-Bereitstellungs-ID für jedes Berichts-Tool.

Ein neuer Link für das Tool wird in der linken Navigationsliste der Links angezeigt. Nachdem Ally das Tool im Ally-System konfiguriert hat, können Sie über diesen Link auf das Tool zugreifen.

Schlüssel-ID an Ally senden

Gehen Sie zu Behind the Blackboard und erstellen Sie ein Ticket für den Supportfall mit folgenden Informationen, sodass das Ally-Team die Integration im Ally-System konfigurieren kann.

  • Entwicklerschlüssel-ID für jedes Tool
  • LTI-Bereitstellungs-ID für jedes Tool
  • Anfrage zur Einrichtung der LTI 1.3-Tools

Beispiel: Mein Entwicklerschlüssel für den Institutionsbericht lautet: #00000000000000000. Meine Bereitstellungs-ID für den Institutionsbericht lautet: 0000:00c00dc0ec00c00cdc000fced. Bitte richten Sie meinen LTI1.3-Bericht ein.

Sie können separate Berichte für die verschiedenen Unterkonten in Ihrer Canvas-Umgebung haben. Kopieren Sie die Bereitstellungs-ID der Unterkontos und fügen Sie diese Informationen auch zum Supportticket hinzu.

Ally-Ausschnitt im Canvas-Design aktualisieren

Nachdem der Ally-Institutionsbericht mit LTI 1.3 konfiguriert wurde, aktualisieren Sie den Ally-Ausschnitt im Canvas-Design. Es muss ein „lti13Id“-Feld hinzugefügt werden, das der Client-ID des LTI 1.3-Institutionsberichts entspricht (die Ally-Tool-ID).

  1. Gehen Sie als Canvas-Administrator zu Admin und wählen Sie Account (Konto) aus.
  2. Wählen Sie Themes (Designs) aus.
  3. Zeigen Sie auf das aktive Design und wählen Sie Open in Theme Editor (Im Designeditor öffnen) aus.
  4. Wählen Sie die Registerkarte Upload (Hochladen) aus.
  5. Fügen Sie im Javascript-Ausschnitt die Eigenschaft ltil3Id hinzu. Ersetzen Sie [InstitutionalReportDeveloperKeyID] durch die Entwicklerschlüssel-ID Ihres Institutionsberichts.

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

  6. Wählen Sie Apply theme (Design übernehmen).