Creating Canvas Developer Credentials for the Hypothesis LMS App

Creating Canvas Developer Credentials for the Hypothesis LMS App2021-07-01T13:54:58-07:00
  1. Home
  2. Help
  3. Learning Management Systems
  4. Canvas
  5. Creating Canvas Developer Credentials for the Hypothesis LMS App
  1. Home
  2. Help
  3. Tutorials and How-Tos
  4. Creating Canvas Developer Credentials for the Hypothesis LMS App

To enable deeper Hypothesis integration with Canvas, your Canvas administrator will need to generate a Canvas Developer Key before Hypothesis is installed. This key will be tied to the Hypothesis credentials you create as part of the install process.

Note that deleting the Canvas Developer Key and/or creating a new Developer Key for Hypothesis will require making a corresponding new set of Hypothesis credentials and installing a new instance of Hypothesis in Canvas.

You can find the API endpoints used by the Hypothesis LMS app here.

1. Navigate to Admin > Developer Keys and click on the +Developer Key button

Choose the API Key option after clicking “Developer Key”.

2. Fill out the Key Settings form

  • Give the key a sensible name and provide your email address
  • In the **Redirect URIs** field, add:
    https://lms.hypothes.is/canvas_oauth_callback
    https://lms.hypothes.is/module_item_launch_oauth_callback
  • Leave blank the following fields:
    • **Redirect URI (Legacy)**
    • **Vendor Code (LTI 2)**
    • **Icon URL**

Make sure there are no extra spaces or characters copied and pasted here.

3. Click Save Key.

The ID (shown in the Details column) and Key (shown in a pop-up once you click the Show Key button) will correspond to the Canvas Developer ID and Canvas Developer Key fields in our form to generate credentials:

4. Turn the Key on.

Canvas does not turn on Developer credentials by default. Turn on your Developer Key before leaving this page.

5. This step should only be used if your institution enforces scopes on Developer Keys

The following are the API endpoints that Hypothesis requires:

  • url:GET|/api/v1/courses/:course_id/files
  • url:GET|/api/v1/files/:id/public_url
  • url:GET|/api/v1/courses/:id
  • url:GET|/api/v1/courses/:course_id/sections
  • url:GET|/api/v1/courses/:course_id/users/:id
  • url:GET|/api/v1/courses/:course_id/group_categories
  • url:GET|/api/v1/group_categories/:group_category_id/groups
  • url:GET|/api/v1/courses/:course_id/groups

Additionally, you must enable the use of Include Parameters

Related Articles

In order to support easy reuse, revision, remixing, and redistribution, the entire Hypothesis Help knowledge base by Hypothesis is dedicated to the public domain via CC CC0 1.0. While we appreciate attribution and links back to Hypothesis from anywhere these works are published, they are not required. Learn more about how we made the decision to put our guidance in the public domain and let us know how you are putting Hypothesis Help to good use.