Canvas Admin Setup

Upgrading from LTI 1.1 to LTI 1.3

For a full list of frequently asked questions regarding LTI 1.3, see 1.3 FAQ.

There are several benefits to upgrading to LTI 1.3. First, creating individual assignment links in your LMS is no longer necessary to sync individual assignment scores to your LMS. Students can use a generic Perusall link and individual assignment scores will still be sent to the LMS. You can still create individual assignment links, called “deep links” in LTI 1.3, which point to particular Perusall assignments even when the link and assignment do not have matching names. (Note: deep links are automatically created in Canvas as you create Perusall assignments.) Second, your LMS course roster automatically syncs to your Perusall course; instructors will be able to view the full roster in Perusall even before students ever launch into Perusall. That way, instructors can set up groups in advance of the start of the semester. 

A few important notes about migrating an LTI 1.1 integration to an LTI 1.3 integration:

• Users who initially created their Perusall account through an LTI 1.1 integration will receive a one time confirmation email the first time they launch Perusall through an LTI 1.3 integration.
• Existing Perusall courses cannot be upgraded from LTI 1.1 to LTI 1.3; LTI 1.3 will only apply to newly-created courses. Since some LMSs do not allow for both a LTI 1.1 integration and a LTI 1.3 integration to be active simultaneously, we recommend switching over to LTI 1.3 between semesters. Previously created LTI 1.1 courses will not be deleted; instructors will still be able to access them from within their Perusall account even if they can no longer launch them from the LMS.

Administrator setup

If you are using a Testing/Staging Instance, please remember to replace any urls starting in app.perusall with staging.perusall.

• In Canvas, go to Admin > Developer Keys, and then click + Developer Key > LTI Key. The Method will be by entering the URL.
• On the left, enter the following values:
  • Key Name: Perusall 1.3
  • Redirect URIs:

    https://app.perusall.com/ltia/launch

• On the right, enter the following values:
  • Method: Enter URL
  • JSON URL: 

    https://app.perusall.com/ltia/config

  • NOTE: If you'd like Perusall to appear by default in every Canvas course, you can enter the following configuration URL:

    https://app.perusall.com/ltia/config?default=enabled

• Click Save.
• On the Developer Keys page, you should see a new entry for Perusall. Ensure it is set to ON, and take note of the number displayed under the Details column and above the "show key" button; this is the Client ID.

• Now add Perusall as an account-wide app available to instructors. To do this, click Settings > Apps and then click + App (if not visible, click View App Configurations). Click the Configuration Type dropdown and choose By Client ID. Paste in the Client ID from the previous step, and click Submit and then Install. 

• You should see a new entry in the app list for Perusall. Click the gear button to its right and click Deployment Id. 

• Return to Admin > Developer Keys, and edit the Perusall 1.3 developer key, navigate to Placements, and ensure to have the following: Course Navigation, Assignment Selection, and Link Selection:
  • Open Course Navigation, and label Text Perusall 1.3.
  • Open Assignment Selection, and label Text Perusall 1.3.
  • Open Link Selection, and:
    • Add the following Target Link URI:

      • https://app.perusall.com/ltia/launch

    • Select Message Type: LtiDeepLinkingRequest
    • Text: Perusall 1.3
  •   Then, click Save.

• Return to Admin > Developer Keys, and then click + Developer Key > API Key.
• On the left, enter the following values, and then click Save:
  • Key name: Perusall API
  • Redirect URIs:

    https://app.perusall.com/ltia/oauth/response

  • Optional: enforce scopes
    • Please note: we suggest not using Enforce Scopes as it means that additional enhancements to Canvas integration that may be added in the future will require you to update your API Key configuration. (The API allows instructors to import group information, section information, files, and pages from Canvas.) If you Enforce Scopes, you will need to go in and manually update the selected scopes each time new functionality is added to the integration. However, if you prefer to enable the Enforce Scopes option to restrict what the API Key can access, ensure the following are checked:
    • Allow Include Parameters: Enabled
    • Groups

      • url:GET|/api/v1/courses/:course_id/groups

      • url:GET|/api/v1/groups/:group_id

      • url:GET|/api/v1/groups/:group_id/users

    • Group Categories

      • url:GET|/api/v1/group_categories/:group_category_id/groups

      • url:GET|/api/v1/courses/:course_id/group_categories

    • Users 

      • url:GET|/api/v1/users/:user_id/profile
        

    • Pages

      • url:GET|/api/v1/courses/:course_id/pages

      • url:GET|/api/v1/courses/:course_id/pages/:url_or_id

    • Files
      

      • url:GET|/api/v1/courses/:course_id/folders

      • url:GET|/api/v1/courses/:course_id/files

    • Sections
      

      • url:GET|/api/v1/courses/:course_id/sections

• On the Developer Keys page, you should see a new entry for Perusall API. Ensure its state is set to ON, and take note of the number that is displayed under the Details column; this is the API client ID.
• Click Show Key. The string of letters and numbers shown is the API client secret.

Add your LTI Platform through the Institution Dashboard

• To request institutional admin access for your Perusall account (register for an account), for security verification purposes, please email support@perusall.com and point us to an institutional web page that shows your name, email address and title/affiliation.
• Once Perusall has confirmed your request, you will see Institution Dashboard on your Perusall home page (to the left of Get Help), and you can navigate to Settings > LTI 1.3 integrations > Add a new LTI 1.3 integration.  Select your LMS type (Canvas cloud-hosted), and insert your:
  • Client ID
  • Deployment ID* 
  • API client ID
  • API client secret
• Click Ok to finalize your placement, and Save Changes.

If you are using a course level or sub account level deployment, or needing to add deployments for any reason, Perusall institutional admins from institutions with an existing LTI 1.3 integration can now add additional deployment IDs in the Institution Dashboard.

Under LMS type

• • Please select Canvas (cloud-hosted beta environment) for your Canvas beta environment (canvas.beta.instructure).
  • Please select Canvas (cloud-hosted test environment) for your Canvas test environment (canvas.test.instructure).
  • Please select Canvas (self-hosted) if you are using a self-hosted Canvas instance (in which case, you will be asked to provide your Canvas base URL).

Please whitelist messages coming from @perusall.com and @mg.perusall.com to ensure users are able to receive our emails.