Checkmark Plagiarism Logo
Checkmark Plagiarism
Menu
Sign In
Back to SupportAdmin guide
Manual setup · Canvas admins

Canvas Manual Setup Guide

Create Checkmark's LTI 1.3 developer key by hand with the configuration we send you, install it by Client ID, and add an API key.

Get Started Watch the Video Recommended: Dynamic Registration

Most Schools Should Use Dynamic Registration

The Dynamic Registration guide does the same thing with one URL and no JSON. Use this manual setup only if your Canvas can't use Dynamic Registration, or we've asked you to.

Before You Start: Get Your Configuration From Us

Email support@checkmarkplagiarism.com. We send an LTI 1.3 configuration made for your school (it includes your school's own signing key), and we turn Checkmark on once you send back your keys.

  • • You need a Canvas admin account.
  • • Have our JSON configuration ready before step 2.

Watch: Manual Setup in 40 Seconds

Phase 1

Create the LTI Key

Paste the configuration we sent you into a new LTI developer key.

Admin › Developer Keys
1

Open + Developer Key › LTI Key

Admin › Developer Keys

The + Developer Key menu

Click + Developer Key (1), then choose LTI Key from the menu.

2

Paste Our Configuration

Then click Save

The LTI key form with Redirect URIs marked 1, Method set to Paste JSON marked 2, and the configuration marked 3
  • • Key Name: Checkmark Plagiarism.
  • • 1. Redirect URIs: the launch URL below.
  • • 2. Method: Paste JSON.
  • • 3. Paste the JSON we sent, then click Save.
Redirect URI
https://teach.checkmarkplagiarism.com/canvas-lti/launch
3

Turn the Key On and Copy Its Client ID

Back in the Developer Keys list

The Checkmark key in the list with its Client ID marked 1 and the State switch marked 2
  • • 1. The number under Details is the Client ID. Copy it.
  • • 2. Switch the key ON.
4

Install It by Client ID

Admin › Settings › Apps › + App

The Add App dialog with By Client ID marked 1, the Client ID marked 2 and Submit marked 3
  • • 1. Configuration Type: By Client ID.
  • • 2. Paste the Client ID from step 3.
  • • 3. Click Submit, then Install.
Phase 2

Add an API Key

Lets Checkmark read your courses, rosters and assignments, and post results.

Admin › Developer Keys
5

Create an API Key for Checkmark

One more developer key, so Checkmark can read courses and rosters

The Canvas API key form with Key Name, Redirect URIs and Enforce Scopes marked 1 to 3
  • • In Admin › Developer Keys, click + Developer Key and choose API Key.
  • • 1. Name it, for example Checkmark Plagiarism API.
  • • 2. Paste both redirect URIs, one per line.
  • • 3. Turn on Enforce Scopes and tick the scopes listed here.
  • • Click Save, then switch the key to ON in the list.
Redirect URIs
https://teach.checkmarkplagiarism.com/teacher/canvas/oauth/callback https://teach.checkmarkplagiarism.com/student/canvas/oauth/callback
Searching the scope list for submissions endpoints in the Canvas API key form

Tip: type part of each path into Search endpoints to find it quickly.

Required scopes (22)
Assignments
  • url:GET|/api/v1/courses/:course_id/assignments
  • url:GET|/api/v1/courses/:course_id/assignments/:id
  • url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/overrides
Courses
  • url:GET|/api/v1/users/:user_id/courses
  • url:GET|/api/v1/courses/:course_id/users
  • url:GET|/api/v1/courses/:id
Enrollments
  • url:GET|/api/v1/courses/:course_id/enrollments
  • url:GET|/api/v1/sections/:section_id/enrollments
  • url:GET|/api/v1/users/:user_id/enrollments
Sections
  • url:GET|/api/v1/courses/:course_id/sections
  • url:GET|/api/v1/sections/:id
Submissions
  • url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
  • url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
  • url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
  • url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
  • url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/files
  • url:DELETE|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/:id
Quiz Questions
  • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
  • url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
  • url:PUT|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
  • url:DELETE|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
  • url:POST|/api/v1/courses/:course_id/quizzes/:id/reorder

Last Step: Send Us Your Keys

Email support@checkmarkplagiarism.com with the LTI key's Client ID and the API key's Key ID and secret (send the secret in a separate message, or ask us for a secure link).

We finish the connection and turn Checkmark on. Then see the Canvas teacher guide.

Frequently Asked Questions

One district, many schools as sub-accounts?

Install one key at the root account. We map each sub-account to its Checkmark school using a custom field that our configuration already includes.

Can I write the JSON myself?

Please use the one we send: it contains a signing key generated for your school, and Checkmark only accepts launches signed with it.

Where's the Document Processor?

Our configuration includes the Assignment Document Processor placement. After setup, see the Document Processor guide.

Can we switch to Dynamic Registration later?

Yes. Email us first, so we can move your school to the new registration without interrupting teachers.

Need Help?

Contact Support Dynamic RegistrationCanvas Teacher Guide