This guide will show you how to Connect Canvas API integration to an existing Canvas Plagiarism Framework Integrated with Copyleaks.
1. Log in to Canvas as an Administrator and select the Admin Icon
A side view will open, click on your account (in this example we have "Copyleaks"
2. Click on Developer Keys button at the right side of the screen and click "+ Developer Key"
3. From the drop down menu that appears, Choose "API Key"
4. When the form appears, enter a name of your choice in "Key Name"
5. Next, in a new tab go to Copyleaks-LMS Dashboard integrations page (Leave Canvas tab open). Click on “Connect to API” button on any active Canvas plagiarism framework integration:
6. You will now receive a Redirect URL in the API set up page of Copyleaks. Copy and Paste the Redirect URL into the Key Settings in the Canvas tab.
Once copied, press the Next in Copyleaks
7. Next in Canvas' Key Settings, you have the option to "Enforce Scopes".
A. If Enforce Scopes is disabled in Key Settings, make sure it is also disabled in the Copyleaks API set up page
If you are disabling Enforce Scopes, skip to Step 8, the following steps are if enforce scopes are enabled.
B. If Enforce Scopes is enabled, a user must enable specific scores in order for Canvas API integration to work as intended.
Check the "Allow Include Parameters" check box
Expand the Assignments Tab and view the expanded URL list
check the box for
“url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/overrides”
check the box for
url:GET|/api/v1/courses/:course_id/assignments/:id
Next, expand the Conversations tab
Check the box for "url:POST|/api/v1/conversations"
Next, expand the Courses tab
Check the box for “url:GET|/api/v1/courses/:id”
From the expanded URLs list check the box for
“url:GET|/api/v1/courses/:course_id/users"
Next, scroll to Files and expand
From the expanded urls list, Click on “url:DELETE|/api/v1/files/:id”
checkbox to enable required scope (make sure the checkbox is checked):
Next expand Grading Standards
From the expanded URLs list check the box for
“url:GET|/api/v1/courses/:course_id/grading_standards/:grading_standard_id”
Next expand Groups
From the expanded URLs list check the box for
1. “url:GET|/api/v1/groups/:group_id” and
2. “url:GET|/api/v1/courses/:course_id/groups”
Next expand “Submission Comments” and click on the check box for all the URLs under this field.
Next expand Submissions
select the checkbox for the URL 1.“url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id” and
2. “url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id”
From the expanded URLs list check the box for url:GET|/api/v1/users/:user_id/profile
8. The Next steps are the same for both “Enforce Scopes Enabled” and “Enforce Scopes Disabled” scenarios.
8. Click of the Save button in the bottom right corner
9. Navigate to the "Developer Keys" page, in this page the API key we just configured should be visible when you click on the State Button
A pop up will appear, click "Switch to On"
10. Copy the Client ID from Canvas and paste it in to the Client ID input field in Copyleaks
11. Click "Show Key" in Canvas and copy this Key into the Secret field of Copyleaks
12. In the Copyleaks Canvas API integration page click Next
A new tab will then appear in your Browser to, click Authorize
After authorized, click Next on your Copyleaks page.
Integration page will now display a green ACTIVE next to API Connected.
Now you can proceed to the next step to set up the AI Assessment Overview linked here.
AI Assessment Overview limitations in Canvas:
- Assignments that have been created before the integration with the API & not been opened and saved again by the instructor, will be excluded from the AI assessment overview tool - The instructor or the student will not see those assignments (and the submission that were made in those assignments) in the AI Assessment Overview tool.
- We do not support Rubric assignments or Peer Reviews.
- The AI Assessment Overview tool does not support moving students from one group to another after students have submitted their work.
- Anonymous Grading will only be supported in the View Only option (student info will be hidden).