Skip to main content

LMS: Canvas

Updated

Introduction

There are three parts to the SmarterID installation process

  1. Developer Keys: Configuring the developer keys will enable SmarterID to retrieve additional data required for the application to function properly.
  2. Install Javascript Snippet: SmarterID requires the LMS to have a snippet of Javascript on all pages so it can seamlessly communicate with the underlying identity service. This snippet of Javascript is very similar to what is used when embedding Google Maps or other embeddable services into web applications.
  3. LTI Configuration: SmarterID is added as an external tool just like any other external tool. As an administrator, you will choose at what "level" the tool will be installed. The tool can be installed at the system level (all courses have access to use the tool) or on a course-by-course basis (only certain courses have access to use the tool). The LTI Configuration section below has steps for each of these types of installation to help with the installation process.

Developer Keys

In order for SmarterID to communicate properly with the Canvas installation, some keys must be configured. 

*** Please note that you must be an administrator of your LMS with access to the LMS account management area - this is NOT the same as your user account management area.

1. Click on the Admin menu option from your main LMS navigation menu

dk_image_1.png

2. Select the account you wish to manage. Our LMS demo account is called "SmarterServices" as shown below.

dk_image_2.png

3. Click the Developer Keys menu option.

dk_image_3.png

4. Click the + Developer Key button from the upper right of the screen.

dk_image_4.png

5. Complete the Developer Key form. The only required items are listed below, the other fields can be completed as desired. The redirect URI must be https://signon.smarterservices.com/v1/oauth2/callback as shown in the image below.

dk_images_5.png

6. Click Save Key button.

dk_image_6.png

7. When the list of keys loads, the ID and Key values will need to be copied. Please note the key is much longer than what is visible so when copying, ensure the entire key is being copied.

dk_image_7.png

8. Open an email and send it to developers@smarterservices.com with the subject SmarterID Canvas Keys. In the email please include:

  • The ID value that was assigned to the developer key (in red box above)
  • The Key value that was assigned to the developer key (in red box above)
  • The domain name of your LMS.

9. At this point please wait to hear from the development team regarding your account configuration prior to proceeding to the next section.