Manuels Canvas (fr)Guide de l’administrateur APIComment obtenir un jeton d'accès API pour un compte ?

Comment obtenir un jeton d'accès API pour un compte ?

Canvas permet l'accès programmatique à certaines informations via l'API de Canvas. Les appels de l'API nécessitent une autorisation, et sont faits au nom de l'utilisateur autorisé.

You can see the most up-to-date Canvas API documentation on github, which may or may not be accurate for locally installed instances of Canvas. If you are not using Canvas Cloud, talk to you site administrator about getting an accurate set of API documentation. Documentation can be generated by running rake doc:api on the console.

Une fois que vous avez un identifiant Canvas, vous pouvez créer l'un de ces jetons d'accès à utiliser pour tester vos projets de développement. Ce jeton doit être inclus comme un paramètre de recherche d'URL dans tout appel API fait à Canvas.

Note: API access tokens can only be removed by the user who created the token. Users with masquerading privileges cannot remove the token on behalf of the user.

Ouvrir Paramètres utilisateur

Ouvrir Paramètres utilisateur

Dans Navigation globale, cliquez sur le lien Compte (Account) [1], puis cliquez sur le lien Paramètres (Settings) [2].

Ajouter un nouveau jeton d'accès

Ajouter un nouveau jeton d'accès

Localisez Intégrations Approuvées et cliquez sur le bouton Ajouter Nouveau Jeton d'Accès (Add New Access Token).

Renseigner l'information jeton

Renseigner l'information jeton

Renseignez l'objet du jeton dans le champ objet [1]. Définissez la date d'expiration du jeton en cliquant sur l'icone Calendrier (Calendar) [2]. S'il n'existe aucune échéance pour ce jeton, laissez le champ "échéances" vide. Cliquez sur le bouton Générer un jeton (Generate Token) [3].

Copier un jeton

Copier un jeton

Copiez le jeton que vous avez reçu [1]. Pour générer un nouveau jeton, cliquez sur le bouton Regénérer un jeton (Regenerate Token) [2]. Pour fermer la fenêtre, cliquez sur l'icone X [3].

Remarque : Un jeton ne vous sera attribué qu'une seule fois. Si vous n'en faites pas une copie, vous devrez créer un nouveau jeton.

Visualiser les intégrations approuvées

Visualiser les intégrations approuvées

Visualisez les intégrations approuvées. Vous pouvez supprimer l'intégration en cliquant sur l'icone Supprimer (Delete).