Overview
There are two parts to the SmarterProctoring installation process
LTI Application: SmarterProctoring is added as an LTI 1.3 application with a few clicks.
Developer Keys (optional): Configuring the developer keys will allow SmarterProctoring the ability to pull the data required for exam import and course roster sync. If those features are not desired this part can be skipped as the omission does not actually inhibit the use of the product.
In this article, you will learn:
How to configure the LTI
How to configure the developer keys
⚠️ It takes both a Canvas admin and SmarterProctoring admin to complete this setup. If different people hold these roles ensure they are working together to ensure this integration works properly.
LTI Installation
Looking for the LTI 1.1 guide? Click here view the legacy installation instructions.
Navigate to the Canvas administration area.
Click the Apps option in the left menu
On the Discover tab, enter SmarterProctoring in the search box.
Once filtered, click the SmarterProctoring app.
On the application listing page, click the Configure button.
The application installation dialog will appear.
Copy/paste the Integration Id that was provided to you by the SmarterServices Customer Success Team, click Save & Next.
Ensure all the permissions are enabled, click Next.
Ensure the Data Sharing is set to All user data, click Next.
Deselect any Placements as you may require, click Next.
Scroll down to Placement Names and enter "Proctoring" or however your institution wishes to display the SmarterProctoring tool, click Next.
Review the setup and then click Install App.
Once the app is installed it needs to be made available. Click the pencil icon to change the tool's status.
Ensure the select box has Available selected, click Save.
Confirm the tool status reflects Available.
At this point the LTI tool is installed and enabled in all courses. Should you require to limit the tool usage, you can use the Add Exception option to exclude the tool from appearing in specific courses.
Developer Keys
In order for SmarterProctoring to communicate properly with the Canvas installation some keys must be configured. These keys will allow SmarterProctoring the ability to pull exam and course roster information which is used to enrich the experience while using SmarterProctoring. While this configuring is NOT REQUIRED, many customers opt to complete these steps to use the product to the fullest extent.
Click on the Admin menu option from your main LMS navigation menu.
Select the account you wish to manage. Our LMS demo account is called "SmarterServices" as shown below.
Click the Developer Keys menu option.
Click the + Developer Key button from the upper right of the screen.
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.
We recommend enabling scopes for your developer key. When enabling scopes, please ensure the following scopes are provided to this developer key.
Method | Endpoint |
GET | /api/v1/courses/:course_id/enrollments |
GET | /api/v1/courses/:course_id/quizzes |
GET | /api/v1/courses/:course_id/users |
GET | /api/v1/courses/:course_id/quizzes/:id |
GET | /api/v1/courses/:id |
GET | /api/quiz/v1/courses/:course_id/quizzes/:assignment_id |
GET | /api/quiz/v1/courses/:course_id/quizzes |
7. Click Save Key button.
Once the Developer Keys Load, do the following:
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.
The ID and key will be used in the next few steps, either copy the ID and Key into another file or open a new tab to proceed with the next step.
Navigate to your SmarterProctoring administrative area in your browser. Your SmarterProctoring administrator was provided a specific account special administrative area URL. If you do not have this information, please contact them.
Enter your username and password and click Login.
Once logged in, click your name in the upper right (shown here at Admin User), then click Integration Settings.
Find the integration that you need to update, typically there will be only one integration. Next in the Actions menu, select Integration settings.
The integration settings form will load as seen in the image below.
Authentication Flow: Select OAuth2.
Client ID: This will be the ID from step 8 above.
Client Secret: This will be the secret from step 8 above.
Auth URI: Input the base URL of your LMS. This must be the protocol and domain for your institution's Canvas installation.
Grant Type: The value for this should be authorization_code
Purpose: The default is SmarterProctoring. If you reference the SmarterProctoring system as something else for your student you will want to use that name here.
Post Auth Redirect URI: The value of this should be https://api.smarterservices.com/v1/oauth2/callback
Logout URI: This is optional, but would be the location you wish the student to be directed to upon logout.Click the Save button at the bottom.
At this point the SmarterProctoring account has been configured to allow API access in order to properly pull roster and exam information.