Canvas

This guide provides step-by-step instructions for Canvas administrators to integrate Canvas with GradeChum. 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 GradeChum
  
• 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

4. Fill in the following fields:
   • Key Name: GradeChum App
   • Owner Email: jude@codechum.com
   • Redirect URIs 1. If partnered with GradeChum please update the redirect URI with your subdomain in gradechum.
     • https\://[your_school].gradechum.com/oauth?method=signup\&platform=canvas
     • https\://[your_school].gradechum.com/oauth?method=login\&platform=canvas
     • https\://[your_school].gradechum.com/oauth?method=private_login\&platform=canvas 2. If not partnered, just use the app.gradechum.com with your school abbreviation.
     • https://app.gradechum.com/oauth?method=signup\&abbreviation=[your_school]\&platform=canvas
     • https://app.gradechum.com/oauth?method=login\&abbreviation=[your_school]\&platform=canvas
     • https://app.gradechum.com/oauth?method=private_login\&abbreviation=[your_school]\&platform=canvas
   • Client Credentials Audience: Canvas

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/