Skip to main content

Configurer l'intégration API REST avec la clé de développeur Canvas

La clé de développeur Canvas est une alternative fiable aux jetons d'accès, car tout point de terminaison REST Canvas peut être activé ou désactivé pour les intégrations.

Pour configurer l'intégration API REST, vous devez effectuer les tâches suivantes.

  1. Créer une clé de développeur API dans votre environnement Canvas

  2. Configurer Ally à l'aide de la clé de développeur Canvas

Créer une clé API de développeur

Une clé de développeur API Canvas est essentiellement un ID de clé et une paire secrète associés à une configuration de portée spécifique.

  1. Accédez au compte racine de l'instance Canvas et accédez aux Clés de développeur.

  2. Sélectionnez le bouton + Clé de développeur, puis Clé API.

  3. Entrez un Nom de clé et l'E-mail du propriétaire.

  4. Copiez et collez ce lien dans le champ URL de redirection. Remplacez [AllyEnvironment] par les informations sur l'environnement dans lesquelles votre établissement est hébergé. Remplacez [ClientID] par votre ID client.

    https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback

  5. Sélectionnez le bouton bascule Appliquer les portées pour l'activer.

  6. Cochez la case Autoriser l'inclusion des paramètres.

  7. Activez les portées suivantes à partir du tableau :

    Tableau 7. Activer ces portées

    Nom de l'étendue

    Section

    url:GET|/api/v1/accounts

    Comptes

    url:GET|/api/v1/accounts/:id

    Comptes

    url:GET|/api/v1/accounts/:account_id/sub_accounts

    Comptes

    url:GET|/api/v1/accounts/:account_id/courses

    Comptes

    url:GET|/api/v1/courses/:course_id/assignments

    Travaux

    url:GET|/api/v1/courses/:course_id/assignments/:id

    Travaux

    url:PUT|/api/v1/courses/:course_id/assignments/:id

    Travaux

    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions

    Cours Blueprint

    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations

    Cours Blueprint

    url:GET|/api/v1/courses/:course_id/content_migrations

    Migrations de contenu

    url:GET|/api/v1/courses/:id

    Cours

    url:PUT|/api/v1/courses/:id

    Cours

    url:POST|/api/v1/courses/:course_id/files

    Cours

    url:GET|/api/v1/courses/:course_id/discussion_topics

    Sujets de discussion

    url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id

    Sujets de discussion

    url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id

    Sujets de discussion

    url:GET|/api/v1/accounts/:account_id/terms

    Modalités d'inscription

    url:GET|/api/v1/courses/:course_id/files

    Fichiers

    url:GET|/api/v1/courses/:course_id/files/:id

    Fichiers

    url:PUT|/api/v1/files/:id

    Fichiers

    url:DELETE|/api/v1/files/:id

    Fichiers

    url:GET|/api/v1/courses/:course_id/media_objects

    Objets multimédias

    url:PUT|/api/v1/media_objects/:media_object_id

    Objets multimédias

    url:GET|/api/v1/media_objects/:media_object_id/media_tracks

    Objets multimédias

    url:PUT|/api/v1/media_objects/:media_object_id/media_tracks

    Objets multimédias

    url:GET|/api/v1/courses/:course_id/pages

    Pages

    url:GET|/api/v1/courses/:course_id/pages/:url_or_id

    Pages

    url:PUT|/api/v1/courses/:course_id/pages/:url_or_id

    Pages

    url:GET|/api/v1/courses/:course_id/quizzes

    Questionnaires

    url:GET|/api/v1/courses/:course_id/quizzes/:id

    Questionnaires

    url:PUT|/api/v1/courses/:course_id/quizzes/:id

    Questionnaires



  8. Sélectionnez Enregistrer.

  9. La nouvelle clé est ajoutée à la page des clés de développeur et est désactivée par défaut.

  10. Activez la nouvelle clé.

  11. Copiez l'ID de clé dans la colonne Détails.

Environnement Ally pour votre région

Utilisez les informations relatives à l’environnement Ally dans lequel votre établissement est hébergé.

  • Centre de données américain : prod.ally.ac

  • Centre de données canadien : prod-ca-central-1.ally.ac

  • Centre de données européen : prod-eu-central-1.ally.ac

  • Centre de données de Singapour : prod-ap-southeast-1.ally.ac

  • Centre de données australien : prod-ap-southeast-2.ally.ac

Configurer Ally avec la clé de développeur

Vous devez être connecté à la fois à votre environnement Canvas et à votre page Configuration Ally.

  1. Accédez à votre page Configuration Ally et sélectionnez l'onglet Clé de développeur Canvas.

  2. Sélectionnez Configurer Ally avec la clé de développeur Canvas.

  3. Copiez et collez la clé et le secret de la clé de développeur API que vous avez créée.

  4. Sélectionnez Enregistrer et accorder l'accès.

  5. Sélectionnez Autoriser pour permettre à Ally d'utiliser la clé de développeur Canvas.

En arrière-plan, Ally effectue une brève vérification pour s'assurer que les portées correctes ont été ajoutées sur la clé de développeur Canvas.

Si tout est correct, vous devriez être redirigé vers l'outil de configuration avec un message indiquant que l'intégration a été configurée correctement.