Skip to content

Canvas API Endpoints Used by the Hypothesis LMS App

Jump to bottom
katelyn edited this page Jan 14, 2019 · 13 revisions

The Hypothesis LMS app includes an optional feature for Canvas installs, called the Canvas File Picker, which allows users to select PDFs from their Canvas course file repository. Enabling this feature requires creating a Canvas developer key before proceeding with app installation.

Canvas allows admins to create scoped developer keys, so that external apps and tools are not granted access to any data that is not required for the app/tool to function. Our LMS app does not specify scopes when it requests an OAuth token, so scoped dev keys do not yet work.

Canvas admins should know that the Canvas File Picker accesses the following Canvas API endpoints:

  1. The List Files API (to show the teacher the list of Canvas files to choose from)
  2. The Inline Preview URL API (to get a "public" URL for the file so we can show the file to the user and let them annotate it)

If a Canvas Developer Key is not provided, users will still be able to create Hypothesis-enabled readings with public URLs and PDFs from their Google Drive accounts.

Clone this wiki locally