Wenn Sie ein API-Zugangs-Token generiert haben, können Sie es für API-Aufrufe verwenden.
Canvas-Token sind mit Canvas-Berechtigungen verknüpft. Wenn Ihr Canvas-Konto gelöscht wird oder Sie nicht mehr Admin sind, werden auch Ihre Token widerrufen.
Option Eins: Aufruf über HTTPS
Alle API-Aufrufe müssen ebenfalls über HTTPS erfolgen. Das Zugangs-Token muss als URL-Abfrageparameter in allen API-Aufrufen an Canvas enthalten sein. Der Endpunkt, um die Liste der Kurse von Benutzer*innen abzurufen, lautet zum Beispiel:
- GET /api/v1/courses.json
Um Bobs Kursliste abzurufen und wenn Bobs Zugriffstoken „token_of_magical_powers“ wäre, würden Sie Folgendes aufrufen
- GET /api/v1/courses.json?access_token=token_of_magical_powers
Ein ausführliches Beispiel für die Verwendung der API finden Sie in der Dokumentation der API-Grundlagen auf Github.
Option Zwei: Aufruf über Request-Header
Die andere Möglichkeit, einen API-Aufruf mit einem Zugangs-Token zu tätigen, besteht darin, es in den Request-Header einzufügen. Wenn Sie curl verwenden (ein Befehlszeilenprogramm, das für die Ausführung von API-Anfragen verwendet werden kann), würden Sie das Zugangs-Token wie folgt angeben.
- curl -H "Authorization: Bearer <token>" 'https://<canvas>/api/v1/accounts/<account_id>/courses.json'
Beachten Sie, dass der „access_token“ überhaupt nicht in der URL enthalten ist.
Sehen Sie sich das Beispiel auf der API-Dokumentationsseite an.
