Guías de Canvas (Spanish)Guías de CanvasGuía de Administración de Canvas API¿Cómo hacer llamadas de API en una cuenta con un autentificador de acceso?

¿Cómo hacer llamadas de API en una cuenta con un autentificador de acceso?

Si ha generado un autentificador de acceso a la API, puede usarlo para hacer llamadas de API.

Los autentificadores de Canvas se alinean con los permisos de Canvas. Si su cuenta de Canvas se elimina o si usted ya no es un administrador, sus autentificadores también se revocarán.

Opción uno: Hacer una llamada por HTTPS


GET /api/v1/courses.json

Todas las llamadas de API también se deben hacer por HTTPS. El autentificador de acceso se debe incluir como un parámetro de consulta de URL en cualquier llamada de API hecha a Canvas. Por ejemplo, el terminal para agarrar la lista de cursos del usuario es:

  • GET /api/v1/courses.json

Para recuperar la lista de Bob del curso y si el autentificador de acceso de Bob era "token_of_magical_power" entonces usted haría la llamada

  • GET /api/v1/courses.json?access_token=token_of_magical_powers

Para un ejemplo detallado del uso de la API, consulte la documentación básica de la API en Github.

Opción dos: Hacer una llamada usando un encabezado de solicitud

Opción dos: Hacer una llamada usando un encabezado de solicitud

La otra forma de hacer una llamada de API con un autentificador de acceso es agregarlo al encabezado de la solicitud.  Si se utiliza curl (un programa de línea de comandos que se puede utilizar para ejecutar solicitudes de API), se tiene que especificar el autentificador de acceso así.  

  • curl -H "Authorization: Bearer <token>" 'http://<canvas>/api/v1/accounts/<account_id>/courses.json'

Observe que el autentificador de acceso no aparece para nada en la URL.

Consulte el ejemplo en el sitio de documentación de la API.