Canvas Developer Key ist eine robuste Alternative zum Zugriffstokenansatz, da jeder Canvas-REST-Endpunkt (Bereich) für Integrationen aktiviert oder deaktiviert werden kann.

Um die REST-API einzurichten, müssen Sie Folgendes tun:

  1. API-Entwicklerschlüssel in Ihrer Canvas-Umgebung erstellen
  2. Ally mit dem Canvas Developer Key konfigurieren

API-Entwicklerschlüssel erstellen

Ein Canvas API Developer Key ist im Wesentlichen ein Paar aus Schlüssel-ID und Geheimschlüssel in Kombination mit einer bestimmten Bereichskonfiguration.

  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 API Key (API-Schlüssel) aus.
  3. Geben Sie einen Schlüsselnamen und eine E-Mail-Adresse des Eigentümers an.
  4. 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. Ersetzen Sie [ClientID] durch Ihre Client-ID.

    https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback

  5. Wählen Sie den Umschalter Enforce Scopes (Bereiche erzwingen) aus, um ihn zu aktivieren.
  6. Aktivieren Sie das Kontrollkästchen Allow Include Parameters (Include-Parameter zulassen).
  7. Aktivieren Sie diese Bereiche in der Tabelle:
    Diese Bereiche aktivieren
    Bereichsname Abschnitt
    url:GET|/api/v1/accounts Konten
    url:GET|/api/v1/accounts/:id Konten
    url:GET|/api/v1/accounts/:account_id/sub_accounts Konten
    url:GET|/api/v1/accounts/:account_id/courses Konten
    url:GET|/api/v1/courses/:course_id/assignments Aufgaben
    url:GET|/api/v1/courses/:course_id/assignments/:id Aufgaben
    url:PUT|/api/v1/courses/:course_id/assignments/:id Aufgaben
    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions Blueprint-Kurse
    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations Blueprint-Kurse
    url:GET|/api/v1/courses/:course_id/content_migrations Inhaltsmigrationen
    url:GET|/api/v1/courses/:id Kurse
    url:PUT|/api/v1/courses/:id Kurse
    url:POST|/api/v1/courses/:course_id/files Kurse
    url:GET|/api/v1/courses/:course_id/discussion_topics Diskussionsthemen
    url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id Diskussionsthemen
    url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id Diskussionsthemen
    url:GET|/api/v1/accounts/:account_id/terms Anmeldebedingungen
    url:GET|/api/v1/courses/:course_id/files Dateien
    url:GET|/api/v1/courses/:course_id/files/:id Dateien
    url:PUT|/api/v1/files/:id Dateien
    url:DELETE|/api/v1/files/:id Dateien
    url:GET|/api/v1/courses/:course_id/pages Seiten
    url:GET|/api/v1/courses/:course_id/pages/:url_or_id Seiten
    url:PUT|/api/v1/courses/:course_id/pages/:url_or_id Seiten
    url:GET|/api/v1/courses/:course_id/quizzes Quiz
    url:GET|/api/v1/courses/:course_id/quizzes/:id Quiz
    url:PUT|/api/v1/courses/:course_id/quizzes/:id Quiz
  8. Wählen Sie Speichern.
  9. Der neue Schlüssel wird zur Seite mit den Entwicklerschlüsseln hinzugefügt und ist standardmäßig Deaktiviert.
  10. Aktivieren Sie den neuen Schlüssel.
  11. Kopieren Sie die Schlüssel-ID-Nummer aus der Spalte Details. 

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

Ally mit dem Entwicklerschlüssel konfigurieren

Sie müssen sowohl bei Ihrer Canvas-Umgebung als auf Ihrer Seite für die Ally-Konfiguration angemeldet sein.

  1. Gehen Sie zur Seite mit der Ally-Konfiguration und wählen Sie die Registerkarte Canvas Developer Key aus.
  2. Wählen Sie Configure Ally with Canvas Developer Key (Ally mit Canvas Developer Key konfigurieren).
  3. Kopieren Sie den Schlüssel und den Geheimschlüssel des von Ihnen erstellten API Developer Key und fügen Sie sie ein.
  4. Wählen Sie Speichern und Zugriff gewähren.
  5. Wählen Sie Autorisieren , um Ally die Berechtigung zur Verwendung des Canvas Developer Key zu erteilen.

Im Hintergrund führt Ally eine schnelle (minimale) Überprüfung durch, um sicherzustellen, dass dem Canvas Developer Key die richtigen Bereiche hinzugefügt wurden.

Wenn alles in Ordnung ist, sollten Sie zurück zum Konfigurationstool mit der Meldung weitergeleitet werden, dass die Integration korrekt konfiguriert wurde.