Setting Up LTI Deep Linking with Canvas for your District

This article provides instruction for district administration and IT in setting up a LTI 1.3/Advantage Canvas Configuration. 

Setting up Deep Linking can only be done using a paid Root Administrator Canvas account. 

Developer Keys (Part 1)
  1. Start on the Admin tab inside of Canvas. 
  2. Select Studies Weekly.
  3. Select Developer Keys.

   

On the next screen under Account, choose Developer Key, then LTI Key.

You will revisit Developer Keys after completing the Key Settings.

Key Settings

It is important to use the correct Key Settings, so we recommend you copy and paste the following links. 

    1. Key Name: Studies Weekly.
    2. Redirect URLs:
      • https://online-api.studiesweekly.com/lti/v1p3
      • https://online-api.studiesweekly.com/lti/v1p3/register
      • https://online-api.studiesweekly.com/lti/v1p3/jwks
      • https://online-api.studiesweekly.com/lti/v1p3/login
      • https://online-api.studiesweekly.com/lti/v1p3/launch
      • httphttps://online-api.studiesweekly.com/lti/v1p3/deeplink
    3. Method: Manual Entry. 
    4. Title: Studies Weekly LTI 1.3/Advantage
    5. Description: Studies Weekly LTI 1.3/Advantage
    6. Target Link URI: https://online-api.studiesweekly.com/lti/v1p3/launch
    7. OpenID Connect Initiation URL: https://online-api.studiesweekly.com/lti/v1p3/login
    8. JWK Method: Public JWK URL
    9. Public JWK URL: https://online-api.studiesweekly.com/lti/v1p3/jwks
    10. LTI Advantage Services: Turn on the first five options.
Additional Key Settings

Under Additional Settings, set the Privacy Level to Public

Placements

You can specify where to place Studies Weekly Online links in Canvas using the Placements dropdown menu. Canvas will include a corresponding configuration section for each placement you add.

If you select Course Navigation as your placement use the following links:

  • Target Link URI: https://online-api.studiesweekly.com/lti/v1p3/launch
  • Icon URL: https://cdn.studiesweekly.com/online/img/icons/sm-coin-icon-classes.png

If you select Link Selection as your placement use the following links:

  • Target Link URI: https://online-api.studiesweekly.com/lti/v1p3/deeplink
  • Icon URL: https://cdn.studiesweekly.com/online/img/icons/sm-coin-icon-classes.png

If you select Assignment Selection as your placement use the following links:

  • Target Link URI: https://online-api.studiesweekly.com/lti/v1p3/deeplink
  • Icon URL: https://cdn.studiesweekly.com/online/img/icons/sm-coin-icon-classes.png

Save your Key Settings in the bottom right corner, to return the the Developer Keys.

Developer Keys (Part 2)

Canvas Courses require a Client Id number for Deep Linking. Studies Weekly will need to register your Client ID number before you can link it to your courses. To start using the number, adjust the State toggle from OFF to ON.

Copy the Client ID number to install (paste) it in a Canvas Course. Proceed to Classroom Settings steps to paste the copied Client ID.

Classroom Settings

To select the Course you wish to add the Client Id to navigate to the Courses tab.  

  1. Choose Courses from the side navigation panel.
  2. Select Settings.
  3. Open the Apps tab.
  4. Followed by View App Configurations.

Next, you will need to add the Client Id. Start by selecting +App.

  1. In the modal, select By Client ID from the dropdown.
  2. Paste the Client ID number in the Client ID field.
  3. Click Submit.

Lastly, you will select Install.

 

The Developer Key will now appear as an External App.

From here you will go to the Settings gear and choose Deployment Id.

 

 

 Important

You will need to register with Studies Weekly by sending an email to rostering@studiesweekly.com. The following information will need shared to complete your registration. 

  • Platform Id: https://canvas.instructure.com
  • Client Id: steps can be found above.
  • Deployment Id: steps can be found above. 

Once you have registration confirmation from Studies Weekly the process is complete. Teachers are then able to add Studies Weekly links into Canvas. 

Visit the Help Center article How to Use LMS Deep Linking as a Teacher for additional information.