La clave para desarrolladores de Canvas es una alternativa sólida al token de acceso, ya que se puede habilitar o deshabilitar cualquier extremo de REST de Canvas (alcance) para las integraciones.

Para configurar la integración de la API de REST, debe hacer lo siguiente:

  1. Cree una clave de API para desarrolladores en su entorno de Canvas.
  2. Configure Ally con la clave para desarrolladores de Canvas.

Cree una clave de API para desarrolladores

Un clave de API para desarrolladores de Canvas es básicamente un par de secreto e ID de la clave combinados con una configuración específica de alcance.

  1. Diríjase a la cuenta raíz de la instancia de Canvas y vaya a Claves para desarrolladores.
  2. Haga clic en el botón Agregar clave para desarrolladores y seleccione Clave de API.
  3. Proporcione un Nombre de la clave y un Correo electrónico del propietario.
  4. Copie y pegue este enlace en el campo URI de redirección. Reemplace [AllyEnvironment] por la información del entorno en el que se aloja su institución. Reemplace [ClientID] por su ID de cliente.

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

  5. Seleccione el botón de alternancia Establecer alcance para activarlo.
  6. Marque la casilla de verificación Permitir que se incluyan parámetros.
  7. Habilite estos alcances desde la tabla:
    Habilite estos alcances
    Nombre de alcance Sección
    url:GET|/api/v1/accounts Cuentas
    url:GET|/api/v1/accounts/:id Cuentas
    url:GET|/api/v1/accounts/:account_id/sub_accounts Cuentas
    url:GET|/api/v1/accounts/:account_id/courses Cuentas
    url:GET|/api/v1/courses/:course_id/assignments Actividades
    url:GET|/api/v1/courses/:course_id/assignments/:id Actividades
    url:PUT|/api/v1/courses/:course_id/assignments/:id Actividades
    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions Cursos modelo
    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations Cursos modelo
    url:GET|/api/v1/courses/:course_id/content_migrations Migraciones de contenido
    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 Temas de debate
    url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id Temas de debate
    url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id Temas de debate
    url:GET|/api/v1/accounts/:account_id/terms Períodos de inscripción
    url:GET|/api/v1/courses/:course_id/files Archivos
    url:GET|/api/v1/courses/:course_id/files/:id Archivos
    url:PUT|/api/v1/files/:id Archivos
    url:DELETE|/api/v1/files/:id Archivos
    url:GET|/api/v1/courses/:course_id/pages Páginas
    url:GET|/api/v1/courses/:course_id/pages/:url_or_id Páginas
    url:PUT|/api/v1/courses/:course_id/pages/:url_or_id Páginas
    url:GET|/api/v1/courses/:course_id/quizzes Cuestionarios cortos
    url:GET|/api/v1/courses/:course_id/quizzes/:id Cuestionarios cortos
    url:PUT|/api/v1/courses/:course_id/quizzes/:id Cuestionarios cortos
  8. Seleccione Guardar.
  9. Se agregará la nueva clave a la página Claves para desarrolladores y se encontrará Desactivada de forma predeterminada.
  10. Active la clave nueva.
  11. Copie el número de ID de la clave en la columna Detalles. 

Entorno de Ally para su región

Utilice la información del entorno de Ally en el que se aloja su institución.

  • Centro de datos de EE. UU.: prod.ally.ac
  • Centro de datos de Canadá: prod-ca-central-1.ally.ac
  • Centro de datos de Europa: prod-eu-central-1.ally.ac
  • Centro de datos de Singapur: prod-ap-southeast-1.ally.ac
  • Centro de datos de Australia: prod-ap-southeast-2.ally.ac

Configure Ally con la clave para desarrolladores

Debe iniciar sesión tanto en su entorno de Canvas como en la página Configuración de Ally.

  1. Vaya a la página Configuración de Ally y seleccione la pestaña Clave para desarrolladores de Canvas.
  2. Seleccione Configurar Ally con la clave para desarrolladores de Canvas.
  3. Copie y pegue la clave y el secreto de la clave de API para desarrolladores que creó.
  4. Seleccione Guardar y otorgar acceso.
  5. Seleccione Autorizar, y otorgará permiso a Ally para que use la clave para desarrolladores de Canvas.

Ally ejecutará un control rápido (mínimo) en segundo plano para garantizar que se agregaron los alcances adecuados a la clave para desarrolladores de Canvas.

Si todo está en orden, se lo redirigirá de nuevo a la herramienta de configuración con un mensaje que indica que se configuró correctamente la integración.