Guías de Canvas (Spanish)Guías de CanvasGuía de Administración de Canvas Integraciones¿Cómo habilito el alcance para una clave de API de desarrollador en una cuenta?

¿Cómo habilito el alcance para una clave de API de desarrollador en una cuenta?

Como parte de crear nuevas claves API del desarrollador o editar las claves del desarrollador existentes en su cuenta, puede personalizar el acceso que recibe la clave API. Establecer los alcances le permite controlar el acceso directo y los terminales específicos de API para herramientas de terceros asociadas con su institución.

De manera predeterminada, el establecimiento del alcance está desactivado al crear una nueva clave API del desarrollador, lo que permite a los autorizadores tener acceso a todas las terminales disponibles para el usuario que autoriza. Sin embargo, se pueden editar los alcances de una clave API del desarrollador en cualquier momento y se pueden actualizar los autentificadores de acceso del usuario que autoriza apropiadamente.

Notas:

  • Administrar las claves del desarrollador es un permiso de la cuenta. Si no puede administrar las claves del desarrollador, este permiso no se ha habilitado para su rol de usuario.
  • Las claves del desarrollador no están disponibles en las subcuentas.

Abrir Cuenta

Abrir Cuenta

En la Navegación Global (Global Navigation), haga clic en el enlace Administrador (Admin) [1] y luego en el nombre de la cuenta [2].

Abrir Claves del desarrollador

Abrir Claves del desarrollador

En la Navegación de la cuenta, haga clic en el enlace Claves del desarrollador (Developer Keys).

Agregar clave del desarrollador

Agregar clave del desarrollador

Haga clic en el botón Agregar clave del desarrollador (Add Developer Key).

Agregar una clave API

Agregar una clave API

Haga clic en la opción Agregar una clave API (Add API Key).

Establecer alcance

Establecer alcance

Después de haber completado la información de la clave del desarrollador, haga clic en el botón Establecer alcances (Enforce Scopes).

Permitir Parámetros de inclusión

Permitir Parámetros de inclusión

Para permitir el uso de todos los parámetros de "inclusión" para esta clave, haga clic en la casilla de verificación Permitir Parámetros de inclusión (Allow Include Parameters).

Los parámetros de "inclusión" pueden dar acceso a datos adicionales que no están incluidos en la tabla de Terminales.

Buscar terminales

Buscar terminales

Para buscar un terminal específico, ingrese el nombre del terminal en el campo Buscar terminales (Search Endpoints) [1].

Para ver todos los terminales disponibles, desplácese por la tabla de Terminales [2].

Seleccionar los terminales de solo lectura

Seleccionar los terminales de solo lectura

Para otorgar acceso de solo lectura (GET) a la clave del desarrollador, seleccione la casilla de verificación Solo lectura (Read only). La tabla se actualizará automáticamente y seleccionará todos los alcances que contengan terminales de solo lectura.

Seleccionar terminales individuales

Seleccionar terminales individuales

Puede otorgar acceso personalizado a la clave API del desarrollador. Haga clic en cualquier nombre del alcance para ver los terminales disponibles [1]. Seleccione los terminales deseados haciendo clic en la casilla de verificación junto al nombre del terminal [2]. La línea del nombre del alcance se actualizará para mostrar el resumen del acceso del terminal seleccionado colectivo [3].

Guardar la clave

Guardar la clave

Haga clic en el botón Guardar (Save).