Canvas Admin Setup

If you are planning to conduct testing, we welcome you to do so in our testing environment, staging.perusall.com.  Staging is only for testing and should not contain any real course or student data.

Disclaimer: Data on staging may be removed at any time.
 

Step 1: Set Up and Deploy the LTI 1.3 Key

Installing the LTI Key

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

   • Redirect URIs:

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

3. On the right, enter the following values:

   • Method: Enter URL

   • JSON URL: 

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

   If you'd like Perusall to appear in every Canvas course navigation by default, you can enter the following configuration URL:
   
   https://app.perusall.com/ltia/config?default=enabled

4. Click Save.

Locating the client ID

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. Copy this.

Deploying the tool

Now add Perusall as an account-wide app available to instructors. To do this,

1. Click Settings > Apps and then click + App (if not visible, click View App Configurations > + App).
2. Click the Configuration Type dropdown and choose By Client ID.
3. Paste in the Client ID, click Submit > Install.
4. Locate Perusall in the app list, click the gear button to the right, and click Deployment Id. Save this for later.

While we recommend an account-wide installation, you can also deploy Perusall to specific sub-accounts or individual courses. To do this, go to Settings > Apps within the specific sub-account or course, and follow the above steps for that location. If you need assistance with this setup, please contact Perusall Support.

Labelling placements

Return to Admin > Developer Keys to edit the Perusall 1.3 LTI Key.  Navigate to Placements, and ensure the following placements are enabled:

• Course Navigation
• Assignment Selection
• Link Selection

Expand each placement option, and enter "Perusall 1.3" in Text field, and save.

• If any of the placements are missing, follow these steps for inserting the specific placement(s):
  1. In the Placements dropdown, search for the desired placement, and click on it to add it.
  2. Enter https://app.perusall.com/ltia/launch for the Target Link URI.
  3. Under Select Message Type:
     
      
     • Enable LtiDeepLinkingRequest for Assignment Selection & Link Selection.
       
        
     • Enable LtiResourceLinkRequest for Course Navigation.
  4. Enter Perusall 1.3 in the Text field.
  5. Click Save.

Step 2: Adding Perusall API Key

The API currently supports importing groups, sections, files, pages, and rubrics from Canvas.

1. Return to Admin > Developer Keys, and then click + Developer Key > API Key.
2. On the left, enter the following values, and then click Save:
   • Enter Perusall API for the Key Name.

   • Enter Redirect URIs:

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

• We recommend not using "Enforce Scopes" as it requires manual updates to your API Key configuration whenever new Canvas integration features are added. If you choose to enforce scopes, ensure you manually update the selected scopes whenever new functionality is introduced. However, if you prefer to restrict API Key access, make sure to enable Allow Include Parameters and the following scopes:
  •  

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

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

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

  •  

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

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

  •  

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

  •  

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

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

  •  

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

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

  •  

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

  •  

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

    • url:GET|/api/v1/courses/:course_id/rubrics/:id
       

1. Locate the API Client ID.

   On the Developer Keys page, you locate the Perusall API Key. 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.

2. Locate the API Client Secret.

   Click Show Key. The string of letters and numbers shown is the API client secret.

Step 3: Add your LTI Platform through the Institution Dashboard

Please follow the steps below to finalize your integration by adding the Perusall LTI 1.3 tool information from your LMS to our list of LTI Platforms using your Institution Dashboard. 

• Register for an account.

• Contact Perusall support, and point us to an institutional web page that shows your name, email address and title/affiliation.

  If you are using staging.perusall.com, please register for a staging account, provide the verification details above, and when you contact Perusall support, please let us know you'd like access to the Staging institution dashboard.

• 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.

Learn more about your Institution dashboard features.

• If you are using a Canvas Beta environment (canvas.beta.instructure), select Canvas (cloud-hosted beta environment) for your LMS type.
• If you are using a Canvas Test environment (canvas.test.instructure), select Canvas (cloud-hosted test environment) for your LMS type.
• If you are using a self-hosted Canvas instance, select Canvas (self-hosted) for your LMS type.  You will also be asked to provide your Canvas base URL.

Updating tool information

If you need to expand your LMS integration or update your credentials—such as adding new deployment IDs, updating your API client ID, or rotating your API client secret—users with access to the Institution dashboard can do so directly from their settings.

Adding New Deployment IDs

Use this process if you are adding new deployment IDs for a course-level or sub-account level deployment:

1. Navigate to Settings > LTI 1.3 Integrations.

2. Locate and expand the relevant Tool client ID.

3. Under the Deployments section, enter the new ID in the Enter new deployment ID field.

4. Click the checkmark (Add Deployment ID) and then click Save changes.

Updating API Client IDs or Secrets

Use this process if your institution is rotating its API keys or regenerating credentials:

1. Navigate to Settings > LTI 1.3 Integrations.

2. Locate and expand the relevant Tool client ID.

3. Under the LMS API credentials section, update the API client ID field, or paste your new secret into the API client secret field. Note: For security reasons, the existing secret will not be displayed.

4. Click Save changes to finalize your updates.

How can I test the integration?

Once your credentials have been entered into our platform list, you can test the integration by following Canvas Instructor Setup & Canvas Integration Features.

LTI 1.3 courses offer a new grade sync feature: LMS gradebook column management.  Learn more about grade sync in LTI 1.3 courses.

If you are using Blueprint (Parent) courses in Canvas, see How do I use Perusall with parent/child LMS courses?

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

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