Como administrador, puede crear las claves API del desarrollador para cuentas principales. Una clave API del desarrollador es un código dado al desarrollador de una aplicación externa que permite acceso a determinada información y permisos dentro de Canvas. Las claves API del desarrollador se pueden usar para crear integraciones personalizadas con Canvas y permitir aplicaciones externas para que usen la autenticación de Canvas. La clave API del desarrollador usa OAuth2 para habilitar la aplicación para usar Canvas para la autenticación. Para obtener más información sobre OAuth2, consulte la documentación de OAuth de la API de Instructure.
La clave API del desarrollador se envía desde la aplicación a Canvas cuando un usuario solicita acceso. La aplicación pide al usuario permiso para crear programáticamente un autentificador de acceso a la API. Cuando el usuario autoriza la aplicación, la aplicación externa tendrá el mismo acceso a la información y permisos de cuenta a los que tendrá acceso el usuario. Para obtener más información sobre los documentos del desarrollador, consulte la página GitHub de Instructure.
Alcance de la clave
Las claves API del desarrollador incluyen una funcionalidad para el alcance de la clave como parte de agregar una clave API del desarrollador. Los alcances de la clave le permiten controlar el acceso directo a los terminales específicos de API para herramientas de terceros.
Nota: Claves del desarrollador es un permiso de la cuenta. Si no puede ver el enlace Claves del desarrollador (Developer Keys) en la Navegación global, este permiso no está activado para su cuenta de usuario.
Abrir cuenta (Open Account)
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
En la Navegación de la cuenta, haga clic en el enlace Claves del desarrollador (Developer Keys).
Agregar clave del desarrollador
Haga clic en el botón Agregar clave del desarrollador (Add Developer Key).
Agregar una clave API
Haga clic en la opción Agregar una clave API (Add API Key).
Ingresar las configuraciones de la clave
Ingrese las configuraciones para la clave API del desarrollador.
- Nombre de la clave [1]: En general, el nombre de su aplicación o empresa. Este campo también aparece cuando a los usuarios se les pide que aprueben el acceso a su cuenta de Canvas en su nombre.
- Correo electrónico del propietario [2]: El correo electrónico de la persona que posee la herramienta del desarrollador.
- Redireccionar URI [3]: Los dominios en donde se solicitan los autentificadores. Estas URI no son su URL de Canvas. Para evitar inquietudes de navegador de contenido mezcladas, use https.
- Redireccionar URI (Legacy) [4]: La URI para el redireccionamiento de la clave. Este campo le permite configurar la URI anterior para una herramienta. Finalmente, este campo se eliminará.
- Código de vendedor (LTI 2) [5]: Un código registrado único que identifica al vendedor o al desarrollador de la herramienta externa. Esto es específicamente para las herramientas y aplicaciones LTI 2.
- URL del ícono [6]: La URL del ícono para su herramienta de desarrollador. Esta URL se presenta al usuario para aprobar la autorización para su herramienta. Para evitar inquietudes de navegador de contenido mezcladas, use https.
- Notas [7]: Cualquier nota sobre la clave del desarrollador, como el motivo por el cual se creó.
- Solamente grupos de pruebas [8]: Crea una clave del desarrollador que solamente se pueda usar en el entorno de prueba de Canvas.
- Establecer alcance [9]: Le permite personalizar el acceso para la clave. De lo contrario, la clave tendrá acceso a todos los terminales disponibles para el usuario que autoriza.
Guardar la clave
Haga clic en el botón Guardar (Save).
Ver clave
Vea la clave del desarrollador para su cuenta.
