Set up your Canvas integration

This guide provides all you need to know about configuring and testing your Canvas LTI integration with Perlego.

Table of contents

1. About the Canvas Integration
2. Set up and configure Perlego within Canvas
   
   1. Set up your Developer Key in Canvas
   2. Install the Perlego LTI Tool into Canvas
   3. Send Perlego your ClientID, LMS URL and default access link
3. Testing
   1. Deep linking launch

About the Canvas Integration

The integration allows Canvas admins and instructors to deep-link titles from Perlego to a module within a course.

When a student clicks on a Perlego link they are automatically directed to create their account and once registered they will be automatically logged in, creating a seamless experience for your students.

Set up and configure Perlego within Canvas

Before you start the configuration make sure:

• Your organisation is on the Ultimate plan OR you have purchased the LMS integration as an add-on. 
• You have admin access to your Canvas instance.
• You have a test course within Canvas.
• You have created an access link for new registrations to be sent to.

1. Set up your Developer Key in Canvas

First you’ll need to set up a ClientId using our LTI details below.

1. Using an admin account, navigate to the Admin tab and click the Developer keys tab.
2. Click on the Developer key button followed by the LTI Key option.
3. A form will pop up and you’ll need to enter the following information.
   

   • Key name: Perlego

   • Method: Manual Entry

   • Redirection URI(s): We have 3 URIs for redirection. Ensure all three are inputted into the field each on a new line.

     <https://perlego.ltiaas.com/lti/launch>
     <https://perlego.ltiaas.com>
     <https://perlego.ltiaas.com/>
     

   • Title: Perlego

   • Description: Add books from Perlego

   • Target Link URI: https://perlego.ltiaas.com/lti/launch

   • OpenID Connect Initiation URL: https://perlego.ltiaas.com/lti/login

   • JWK Method: Public JWK URL

   • Public JWK URL: https://perlego.ltiaas.com/lti/keys

4. Ensure the JWK Method is set to Public JWK URL
5. Further down, under LTI Advantage Services, ensure no services are selected as Perlego doesn’t support any LTI Advantage Services.

6. Ensure that the Privacy Level is set to Public under the Additional Settings section.

7. Under placements you must select Link Selection , Tool Configuration, Module Menu Modal and Module Index Menu Modal. This will allow instructors to deep link Perlego books in the course/module.

8. You’ll need to ensure LtiDeepLinkingRequest is set under the Link Selection , Module Menu Modal and Module Index Menu Modal settings.
   Note: Perlego does not support placements that are embedded within Canvas
9. Click Save.

10. The ClientId can be viewed under details. Please also, ensure that the state is switched ON.

11. Make a copy of the ClientId and your Canvas URL as we need to store this against your organisational metadata in our database.

2. Install the Perlego LTI Tool into Canvas

1. In the Canvas Admin menu, navigate to Settings → View App Configurations → Apps then click on the + App button.

2. In the resulting form choose:

   • Configuration Type: By Client ID
   • Client ID: [The Client ID number you found in the previous series of steps]
3. Click Submit. 

3. Send Perlego your ClientID, LMS URL and default access link

Send us the ClientID you’ve generated and your Canvas URL by completing our LMS set up form, so we can complete the registration.

You’ll also need to tell us which access link your LMS users should be directed to for signing up to Perlego. If you don’t have an access link yet you’ll need to create one in Perlego, this requires a Perlego admin login.

Testing

Deep linking launch

These are the steps to test the deep linking launch in Canvas.

1. Open a Course and go to the Modules tab. Click the + button in the module header.

2. Select External tool from the dropdown. Perlego should be displayed as an option. Select Perlego.

3. The Perlego book finder will open. Search for the book you want to link and click Submit.

4. Ensure you select Load in a new tab, then click Add Item.

5. Click on the link you’ve added. It will open the book in Perlego.

   You’ll need to create an account or have an existing account in order to test from the perspective of a student. If you’d like to have a Perlego Admin account, please request an Admin access link/code.