Si vous avez généré un jeton d'accès à l'API, vous pouvez l'utiliser pour effectuer des appels à l'API.
Les jetons de Canvas s'alignent sur les autorisations de Canvas. Si votre compte de Canvas est supprimé ou si vous n'êtes plus administrateur, vos jetons seront également révoqués.
Première option : Passer un appel via HTTPS
Tous les appels d'API doivent également être effectués via HTTPS. Le jeton d'accès doit être inclus en tant que paramètre de requête d'URL dans tous les appels d'API effectués vers Canvas. Par exemple, le point de terminaison permettant de récupérer la liste des cours de l'utilisateur est :
- GET /api/v1/courses.json
Pour récupérer la liste de cours de Bob et si le jeton d'accès de Bob était « token_of_magical_power » alors vous appelleriez
- GET /api/v1/courses.json?access_token=token_of_magical_powers
Pour voir un exemple détaillé d'utilisation de l'API, consultez la Documentation sur les fondements des API sur github.
Deuxième option : Passer un appel à l'aide d'un en-tête de demande
L'autre façon d'effectuer un appel d'API avec un jeton d'accès consiste à l'ajouter à l'en-tête de la requête. Si vous utilisez CURL (un programme de ligne de commande qui peut être utilisé pour exécuter des requêtes d'API), vous spécifierez le jeton d'accès comme ceci.
- curl -H "Authorization: Bearer <token>" 'https://<canvas>/api/v1/accounts/<account_id>/courses.json'
Notez que l'access_token n'est pas du tout dans l'URL.
Voir l'exemple sur le site de la documentation sur les API.
