Canvas

This guide provides step-by-step instructions for Canvas administrators to integrate Canvas with CodeChum. Follow the steps carefully to ensure a successful setup.

---

1. Configure Canvas Developer Key for Canvas REST API

• Objective: Enable your Canvas REST API with limited permissions to be consumed by CodeChum

• Steps:

  1. Log In as Administrator in Canvas LMS.

  2. Navigate to Admin > [Organization] > Developer Keys

  3. Create a new Developer Key for API Key

     

     Navigation flow to locate Developer Key
  4. Fill in the following fields:

     • Key Name: CodeChum App

     • Owner Email: [email protected]

     • Redirect URIs

       1. If partnered with CodeChum please update the redirect URI with your subdomain in codechum.

          • https://[your_school].codechum.com/oauth?method=signup&platform=canvas

          • https://[your_school].codechum.com/oauth?method=login&platform=canvas

          • https://[your_school].codechum.com/oauth?method=private_login&platform=canvas

       2. If not partnered, just use the app.codechum.com with your school abbreviation.

          • https://app.codechum.com/oauth?method=signup&abbreviation=[your_school]&platform=canvas

          • https://app.codechum.com/oauth?method=login&abbreviation=[your_school]&platform=canvas

          • https://app.codechum.com/oauth?method=private_login&abbreviation=[your_school]&platform=canvas

     • Client Credentials Audience: Canvas

       

       Form to locate Client Credentials audience
  5. Enable “Enforce Scopes” and enable the following specific endpoints:

     • /auth/userinfo

     • url:GET|/api/v1/users/:user_id/profile

     • url:GET|/api/v1/users/:user_id/enrollments

     • url:GET|/api/v1/sections/:section_id/enrollments

     • url:GET|/api/v1/courses

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

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

     • url:GET|/api/v1/users/:user_id/courses

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

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

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

     • url:PUT|/api/v1/courses/:course_id/assignments/:id

     • url:POST|/api/v1/courses/:course_id/submissions/update_grades

     • url:POST|/api/v1/sections/:section_id/submissions/update_grades

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

     • url:PUT|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id

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

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

     • url:POST|/api/v1/sections/:section_id/enrollments

     • url:DELETE|/api/v1/courses/:course_id/enrollments/:id

     • url:GET|/api/v1/progress/:id

2. Register and Verify Integration with CodeChum

• Objective: Confirm that the integration with Canvas is successful.

• Steps:

  1. Email the following to [email protected]:

     • Canvas Application ID

     • Canvas API Secret Key

     • Your Canvas full web URL or domain (e.g https://canvas.univ.edu).

  2. Await confirmation from CodeChum.

  3. Once you receive confirmation that everything is set up correctly, the integration process is complete.