Als Administrator können Sie Entwickler-API-Schlüssel für Stammkonten erstellen. Ein Entwickler-API-Schlüssel ist ein Code, den der Entwickler einer Drittanbieteranwendung erhält und der den Zugriff auf bestimmte Informationen und Berechtigungen in Canvas ermöglicht. Entwickler-API-Schlüssel können verwendet werden, um benutzerdefinierte Integrationen mit Canvas zu erstellen und Anwendungen von Drittanbietern die Authentifizierung mit Canvas zu ermöglichen. Der Entwickler-API-Schlüssel verwendet OAuth2, damit die Anwendung Canvas zur Authentifizierung verwenden kann. Weitere Informationen über OAuth2 finden Sie in der Dokumentation zu Instructure API OAuth.
Der Entwickler-API-Schlüssel wird von der Anwendung an Canvas gesendet, wenn ein/e Benutzer*in den Zugriff anfordert. Die Anwendung bittet den/die Benutzer*in um die Erlaubnis, ein API-Zugangs-Token programmatisch zu erstellen. Wenn der/die Benutzer*in die Anwendung autorisiert, hat die Drittanbieteranwendung denselben Zugriff auf Informationen und Kontoberechtigungen wie die Person, die den Zugriff gewährt hat. Weitere Informationen zu Entwicklerdokumenten finden Sie auf der Github-Seite von Instructure.
Schlüssel-Sondierung
Entwickler-API-Schlüssel enthalten Funktionen für die Schlüsselbegrenzung als Teil des Hinzufügens eines Entwickler-API-Schlüssels. Mit Schlüssel-Sondierungen können Sie den direkten Zugriff auf bestimmte API-Endpunkte für Tools von Drittanbietern steuern.
Hinweis: Entwicklerschlüssel sind eine Kontoberechtigung. Wenn Sie den Link „Entwicklerschlüssel“ in der Kontonavigation nicht sehen können, wurde diese Berechtigung für Ihr Benutzerkonto nicht aktiviert.
Konto öffnen
Klicken Sie in der globalen Navigation auf den Link Admin [1] und dann auf den Namen des Kontos [2].
Entwicklerschlüssel öffnen
Klicken Sie in der Kontonavigation auf den Link Developer Keys (Entwicklerschlüssel).
Entwicklerschlüssel hinzufügen
Klicken Sie auf die Schaltfläche Add Developer Key (Entwicklerschlüssel hinzufügen).
API-Schlüssel hinzufügen
Klicken Sie auf die Option Add API Key (API-Schlüssel hinzufügen).
Schlüssel-Einstellungen eingeben
Geben Sie die folgenden Einstellungen für den Entwickler-API-Schlüssel ein:
- Key Name (Schlüsselname) [1]: Normalerweise Ihr App- oder Firmenname. Dieses Feld wird angezeigt, wenn Benutzer*innen aufgefordert werden, den Zugriff auf ihr Canvas-Konto in Ihrem Namen zu genehmigen.
- Owner Email (E-Mail des Eigentümers) [2]: E-Mail des/der Eigentümer*in des Entwickler-Tools.
- Redirect URIs (Weiterleitungs-URIs) [3]: Die Domänen, über die Token angefordert werden. Diese URIs sind nicht Ihre Canvas-URL. Um Probleme mit Browsern mit gemischten Inhalten zu vermeiden, verwenden Sie https.
- Weiterleitungs-URI (Legacy) [4]: Die URI für die Schlüsselweiterleitung. In diesem Feld können Sie die vorherige URI für ein Tool festlegen. Eventuell wird dieses Feld entfernt.
- Vendor Code (Hersteller-Code) (LTI 2) [5]: Ein eindeutiger registrierter Code, der den Hersteller oder Entwickler des Drittanbieter-Tools identifiziert. Dies gilt speziell für LTI 2-Tools und -Anwendungen.
- Icon-URL [6]: Die URL des Symbols für Ihr Entwickler-Tool. Diese URL wird dem/der Benutzer*in angezeigt, um die Autorisierung für Ihr Tool zu genehmigen. Um Probleme mit Browsern mit gemischten Inhalten zu vermeiden, verwenden Sie https.
- Notes (Hinweise) [7]: Notizen zum Entwickler-Schlüssel, z. B. der Grund, warum er erstellt wurde.
- Test Cluster Only (Nur Test-Cluster) [8]: Erzeugt einen Entwicklerschlüssel, der nur in der Canvas-Testumgebung verwendet werden kann.
- Enforce Scopes (Geltungsbereiche erzwingen) [9]: Ermöglicht es Ihnen, den Zugriff für den Schlüssel anzupassen. Andernfalls hat der Schlüssel Zugriff auf alle Endpunkte, die dem/der autorisierenden Benutzer*in zur Verfügung stehen.
Schlüssel speichern
Klicken Sie auf Save (Speichern).
Schlüssel anzeigen
Sehen Sie sich den Entwicklerschlüssel für Ihr Konto an.
