La clau de desenvolupador de Canvas és una alternativa robusta a l'enfocament de testimoni d'accés, perquè tots els extrems REST de Canvas (abast) es poden habilitar o inhabilitar per a les integracions.
Per configurar la integració amb l'API de REST, heu de fer aquestes coses:
- Crear una clau de desenvolupador d'API al vostre entorn de Canvas
- Configurar Ally amb la clau de desenvolupador de Canvas
Crear una clau de desenvolupador d'API
Una clau de desenvolupador d'API de Canvas és bàsicament una parella d'ID de clau i contrasenya combinada amb una configuració d'abast concreta.
- Aneu al compte arrel de la instància de Canvas i aneu a Claus de desenvolupador.
- Seleccioneu el botó + Clau de desenvolupador i seleccioneu Clau LTI.
- Indiqueu un Nom de clau i una Adreça electrònica del propietari.
- Copieu i enganxeu aquest enllaç al camp Redirigeix URI. Substituïu [AllyEnvironment] per la informació de l'entorn on està allotjada la vostra institució. Substituïu [ClientID] amb el vostre ID de client.
https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback
- Seleccioneu el commutador Aplica els abastos per activar-ho.
- Marqueu la casella Permet incIoure paràmetres.
- Habiliteu aquests abastos des de la taula:
Habiliteu aquests abastos Nom de l'abast Secció 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 Tasques url:GET|/api/v1/courses/:course_id/assignments/:id Tasques url:PUT|/api/v1/courses/:course_id/assignments/:id Tasques url:GET|/api/v1/courses/:course_id/blueprint_subscriptions Cursos base url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations Cursos base url:GET|/api/v1/courses/:course_id/content_migrations Migracions de contingut url:GET|/api/v1/courses/:id Cursos url:PUT|/api/v1/courses/:id Cursos url:POST|/api/v1/courses/:course_id/files Cursos url:GET|/api/v1/courses/:course_id/discussion_topics Temes de debat url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id Temes de debat url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id Temes de debat url:GET|/api/v1/accounts/:account_id/terms Terminis d'inscripció url:GET|/api/v1/courses/:course_id/files Fitxers url:GET|/api/v1/courses/:course_id/files/:id Fitxers url:PUT|/api/v1/files/:id Fitxers url:DELETE|/api/v1/files/:id Fitxers url:GET|/api/v1/courses/:course_id/media_objects Objectes multimèdia url:PUT|/api/v1/media_objects/:media_object_id Objectes multimèdia url:GET|/api/v1/media_objects/:media_object_id/media_tracks Objectes multimèdia url:PUT|/api/v1/media_objects/:media_object_id/media_tracks Objectes multimèdia url:GET|/api/v1/courses/:course_id/pages Pàgines url:GET|/api/v1/courses/:course_id/pages/:url_or_id Pàgines url:PUT|/api/v1/courses/:course_id/pages/:url_or_id Pàgines url:GET|/api/v1/courses/:course_id/quizzes Qüestionaris url:GET|/api/v1/courses/:course_id/quizzes/:id Qüestionaris url:PUT|/api/v1/courses/:course_id/quizzes/:id Qüestionaris - Seleccioneu Desa.
- La clau nova s'afegeix a la pàgina de claus de desenvolupador i està desactivada per defecte.
- Activeu la clau nova.
- Copieu el número d'ID de la clau a la columna Detalls.
Entorn d’Ally de la vostra regió
Feu servir la informació de l’entorn d’Ally on està allotjada la vostra institució.
- Centre de dades dels EUA: prod.ally.ac
- Centre de dades canadenc: prod-ca-central-1.ally.ac
- Centre de dades europeu: prod-eu-central-1.ally.ac
- Centre de dades de Singapur: prod-ap-southeast-1.ally.ac
- Centre de dades australià: prod-ap-southeast-2.ally.ac
Configurar Ally amb la clau de desenvolupador
Cal que hàgiu iniciat la sessió a l'entorn de Canvas i a la vostra pàgina de Configuració d'Ally.
- Aneu a la pàgina de la vostra Configuració d'Ally i seleccioneu la pestanya Clau de desenvolupador de Canvas.
- Seleccioneu Configura Ally amb clau de desenvolupador de Canvas.
- Copieu i enganxeu la clau i la contrasenya de la clau de desenvolupador d'API que heu creat.
- Seleccioneu Desa i concedeix l'accés.
- Seleccioneu Autoritza per concedir permís a Ally per fer servir la clau de desenvolupador de Canvas.
En segon terme, Ally farà una comprovació ràpida (mínima) per assegurar que s'han afegit els abastos correctes a la clau de desenvolupador de Canvas.
Si tot va bé, se us hauria de redirigir altre cop a l'eina de configuració i mostrar-vos un missatge per informar-vos que la integració s'ha configurat correctament.
