Legacy Portal: Set Up Your Canvas Roster Sync Integration

In this guide for administrators, you’ll learn how to establish a secure connection between ExamSoft and Canvas by creating a Developer Key and configuring LMS settings.

In this guide:

• Setup Canvas
• Setup ExamSoft

Setup Canvas

1. Log in to Canvas as a System Admin.

2. Select Admin and select the appropriate account.

   

3. Select Developer Keys in the list on the left.

   

   If you do not see this option, you'll need to select a higher-level account.

4. Select + Developer Key and then + API Key.

   

5. Enter your information in the Key Settings fields:

   • For Key Name, enter: ExamSoft
   • For Owner Email, enter your LMS or ExamSoft admin email.
   • For Redirect URLs, enter:
     • https://rsms-api-usw2.integrations.turnitin.com/v1/canvas/oauth2response
     • https://rsms-api-euw1.integrations.turnitin.com/v1/canvas/oauth2response
     • https://rsms-api-apse1.integrations.turnitin.com/v1/canvas/oauth2response
     • https://rsms-api-apse2.integrations.turnitin.com/v1/canvas/oauth2response
   • The remaining fields can be left blank.

   

6. Select Enforce Scopes.

7. Select the Allow Include Parameters checkbox.

   

8. Enable the following endpoints under each category:

   Accounts

   • url:GET|/api/v1/accounts
   • url:GET|/api/v1/course_accounts
   • url:GET|/api/v1/accounts/:id
   • url:GET|/api/v1/accounts/:account_id/help_links
   • url:GET|/api/v1/accounts/:account_id/courses

   Assignments

   • url:GET|/api/v1/courses/:course_id/assignments
   • url:POST|/api/v1/courses/:course_id/assignments

   Courses

   • url:GET|/api/v1/accounts/:account_id/courses/:id
   • url:GET|/api/v1/courses/:course_id/users

   Enrollments

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

   Result

   • url:GET|/api/v1/courses/:course_id/live_assessments/:assessment_id/results

   Roles

   • url:GET|/api/v1/accounts/:account_id/roles

   Sections

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

   Submissions

   • url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
   • url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
   • url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/update_grades
   • url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions

   Users

   • url:GET|/api/v1/users/:id
   • url:GET|/api/v1/accounts/:account_id/users

9. Select Save (in the bottom right corner).

   

10. Under State, select ON for the ExamSoft entry you just created.

    

Setup ExamSoft

1. To access the Canvas integration setup, select the Admin menu option. Then, select the LMS Settings tab.
   

2. Click Edit, then input the following values.

   1. For Canvas Server, paste your Canvas instance URL.
   2. For Client ID, paste the value that you saved earlier in your text file.
   3. For Client Secret, paste the value that you saved earlier in your text file.

   

3. Click Save when you’re done.
4. Select the Generate Key button, and it will launch the Canvas login screen
   
5. Log in with a Canvas admin account.
6. Select Authorize and you'll be redirected to your ExamSoft portal.
   

The initial setup is now complete. Please see our user guide on Configuring the integration and Syncing courses.