En tant qu'administrateur, vous pouvez créer des clés API de développeur pour les comptes racine. Une clé API de développeur est un code donné au développeur d'une application tierce qui permet d'accéder à certaines informations et autorisations dans Canvas. Les clés API de développeur peuvent être utilisées pour créer des intégrations personnalisées avec Canvas et permettre aux applications tierces d'utiliser l'authentification de Canvas. La clé API de développeur utilise OAuth2 pour permettre à l'application d'utiliser Canvas pour l'authentification. Pour plus d'informations sur OAuth2, consultez la documentation sur API OAuth d'Instructure.
La clé API de développeur est envoyée de l'application à Canvas lorsqu'un utilisateur demande l'accès. L'application demande à l'utilisateur l'autorisation de générer automatiquement un jeton d'accès d'API. Lorsque l'utilisateur autorise l'application, l'application tierce aura le même accès aux informations et les mêmes autorisations de compte que l'utilisateur qui a accordé l'accès. Pour plus d'informations sur les documents destinés aux développeurs, consultez la page Github d'Instructure.
Définition de la portée des clés (Key Scoping)
Les clés API de développeur incluent des fonctionnalités pour définir la portée des clés dans le cadre de l'ajout d'une clé API de développeur. La définition de la portée des clés vous permet de contrôler l'accès direct à des points finaux d'API spécifiques pour les outils tiers.
Remarque : Les clés de développeur constituent une autorisation de compte. Si vous ne pouvez pas afficher le lien Clés de développeur dans la navigation du compte, cela signifie que cette autorisation n'a pas été activée pour votre compte utilisateur.
Ouvrir un compte
Dans Navigation globale, cliquez sur le lien Admin [1], puis sur le nom du compte [2].
Ouvrir les clés de développeur
Dans la navigation du compte, cliquez sur le lien the Clés de développeur (Developer Keys).
Ajouter une clé de développeur
Cliquez sur le bouton Ajouter une clé de développeur (Add Developer Key).
Ajouter la clé API
Cliquez ensuite sur l'option Ajouter la clé API (Add API Key).
Saisir les paramètres de la clé
Saisissez les paramètres de la clé API de développeur :
- Nom de la clé (Key Name) [1] : généralement le nom de votre application ou de votre entreprise. Ce champ s'affichera lorsqu'il sera demandé aux utilisateurs d'approuver l'accès à leur compte Canvas en votre nom.
- E-mail du propriétaire (Owner Email) [2] : l'e-mail de la personne propriétaire de l'outil de développement.
- URI de redirection (Redirect URIs) [3] : les domaines où les jetons sont demandés. Ces URI ne sont pas votre URL de Canvas. Pour éviter les problèmes de navigateur de contenu mixte, utilisez https.
- URI de redirection (ancienne) (Redirect URI [Legacy]) [4] : l'URI de redirection de la clé. Ce champ vous permet de définir l'URI précédent d'un outil. Ce champ sera supprimé plus tard.
- Code du fournisseur (LTI 2) (Vendor Code [LTI 2]) [5] : un code enregistré unique qui identifie le fournisseur ou le développeur de l'outil tiers. Ce champ est spécifiquement destiné aux outils et applications LTI 2.
- URL de l'icône (Icon URL) [6] : l'URL de l'icône de votre outil de développement. Cette URL est présentée à l'utilisateur pour approuver l'autorisation de votre outil. Pour éviter les problèmes de navigateur de contenu mixte, utilisez https.
- Remarques [7] : toutes les remarques sur la clé de développeur, telles que la raison pour laquelle elle a été créée.
- Cluster de test uniquement (Test Cluster Only) [8] : crée une clé de développeur qui ne peut être utilisée que dans l'environnement de test de Canvas.
- Respecter les portées (Enforce Scopes) [9] : vous permet de personnaliser l'accès à la clé. Sinon, la clé aura accès à tous les points finaux disponibles pour l'utilisateur donnant l'autorisation.
Enregistrer la clé
Cliquez sur le bouton Enregistrer (Save).
Afficher la clé
Affichez la clé de développeur pour votre compte.
