Configuration de Canvas : connexion API (OAuth)

La connexion API est une clé développeur OAuth, configurée une seule fois pour l'organisation. Chaque utilisateur autorise ensuite Raison avec son propre compte Canvas et ne voit que les cours auxquels ce compte lui donne déjà accès. Canvas reste responsable de ces autorisations.

Raison n'utilise plus de jeton API personnel. Si votre organisation a été configurée avec l'ancien jeton, remplacez-le par l'application OAuth ci-dessous.

Selon votre configuration Canvas, le menu du compte peut afficher le nom de votre établissement au lieu de « Canvas ».

Documentation officielle Canvas : Configuring LTI Advantage tools.

Créer une clé développeur API dans Canvas

Connectez-vous à Canvas en tant qu'administrateur, ou avec un utilisateur autorisé à gérer les clés développeur.
Allez dans Admin → Your Canvas account → Developer Keys.
Sélectionnez + Developer Key → + API Key.

Champ	Valeur recommandée
Key Name	`Raison API`
Owner Email	`[email protected]`

Ces deux champs servent uniquement aux administrateurs à identifier l'intégration par la suite.

Ajouter l'URL de rappel OAuth

Collez ceci dans le champ Redirect URIs de Canvas :

https://services.raison.is/integration/canvas/v2/oauth/callback

Vous pouvez aussi la copier depuis Raison sous Organisation → Intégrations → Canvas → Configurer → Clé API OAuth, champ URL de rappel OAuth.

Copiez l'URL à l'identique. Un caractère manquant, un espace en trop ou un / final amènera Canvas à refuser l'autorisation avec une erreur d'URL de redirection invalide.

Configurer les scopes

Activez Enforce Scopes.

L'option la plus simple consiste à activer tous les scopes en lecture seule disponibles. Pour un contrôle plus strict, sélectionnez uniquement les 12 scopes en lecture seule que Raison appelle réellement :

Scope de l'API Canvas	Rôle
`url:GET\\|/api/v1/courses`	Liste les cours accessibles à l'utilisateur Canvas authentifié.
`url:GET\\|/api/v1/courses/:id`	Récupère les informations d'un cours donné.
`url:GET\\|/api/v1/courses/:course_id/modules`	Liste les modules d'un cours.
`url:GET\\|/api/v1/courses/:course_id/modules/:id`	Récupère les informations d'un module donné.
`url:GET\\|/api/v1/courses/:course_id/modules/:module_id/items`	Liste les éléments d'un module, y compris les pages et fichiers liés.
`url:GET\\|/api/v1/courses/:course_id/modules/:module_id/items/:id`	Récupère les informations d'un élément de module donné.
`url:GET\\|/api/v1/courses/:course_id/files`	Liste les fichiers associés à un cours.
`url:GET\\|/api/v1/files/:id`	Récupère les informations d'un fichier et son URL de téléchargement autorisée.
`url:GET\\|/api/v1/courses/:course_id/pages`	Liste les pages d'un cours.
`url:GET\\|/api/v1/courses/:course_id/pages/:url_or_id`	Récupère le contenu d'une page Canvas donnée.
`url:GET\\|/api/v1/courses/:course_id/users`	Liste les utilisateurs inscrits à un cours.
`url:GET\\|/api/v1/courses/:course_id/folders`	Liste les dossiers d'un cours, afin que les fichiers s'affichent selon leur arborescence Canvas plutôt qu'en liste à plat.

Tous les scopes sont en lecture seule. Raison ne demande jamais l'autorisation de modifier ou de supprimer du contenu Canvas.

Le scope des dossiers est plus récent que l'intégration d'origine. Si une clé a été créée sans lui, ajoutez-le dans Canvas. En attendant, Raison réessaie sans ce scope et les fichiers sont importés en liste à plat.

Enregistrer et activer la clé

Enregistrez la clé, retrouvez-la dans la liste Developer Keys et passez-la sur On dans la colonne State. La clé doit être activée pour que Raison puisse l'utiliser.

Copier les identifiants dans Raison

Dans Canvas, dans la colonne Details de la clé :

l'identifiant numérique est le Client ID
Show Key affiche le Client Secret

Dans Raison, allez dans Organisation → Intégrations → Canvas → Configurer → Clé API OAuth et renseignez :

Champ	Valeur à saisir	Fixe ou spécifique ?
Canvas URL	L'URL de base de votre instance Canvas, par exemple `https://canvas.your-institution.com`. Sans chemin comme `/admin`, `/courses` ou `/login`	Spécifique à votre établissement
Client ID	L'identifiant numérique de la clé développeur API	Spécifique à votre instance Canvas
Client secret	La valeur affichée par Show Key	Spécifique à votre instance Canvas

Sélectionnez Enregistrer l'application OAuth.

Traitez le Client Secret comme un mot de passe. Ne le faites jamais figurer dans des captures d'écran, des e-mails ou des demandes d'assistance.

Tester la connexion API

Utilisez Se connecter et tester l'accès aux cours dans Raison, ou allez dans le tableau de bord et sélectionnez Création rapide → Canvas. Une fenêtre d'autorisation Canvas s'ouvre. Connectez-vous, validez, et vos cours Canvas devraient apparaître dans Raison.

Chaque formateur autorise Canvas avec son propre compte lors de son premier import de contenu : les cours qu'il voit respectent donc toujours son propre périmètre Canvas.

La connexion API importe le contenu. Pour ouvrir l'assistant dans Canvas, configurez aussi Configuration de Canvas : LTI 1.3.

Liste de vérification API

La clé développeur API est activée dans Canvas
L'URL de rappel OAuth correspond exactement
Enforce Scopes est activé et les scopes en lecture seule sont sélectionnés
La Canvas URL, le Client ID et le Client secret sont enregistrés dans Raison
Les cours Canvas apparaissent via Création rapide → Canvas

Articles liés

Besoin d'aide ? Écrivez à [email protected].