Canvas API Developer Key Setup

This guide is for Canvas system administrators and district admins in Next Gen Math. It explains how to create a Canvas API developer key (OAuth) so teachers can connect their Canvas accounts, link assignments, and sync grades. Use the reference values below in Canvas, then enter your instance URL, Client ID, and Client Secret in Next Gen Math.

Creating a Canvas API developer key for
Next Gen Math

Reference: Redirect URI, Logo URL, and OAuth scopes

Use these when configuring the API Key in Canvas. If your organization uses a non-production API hostname, open Next Gen MathSettingsIntegrationsCanvas API and use the Redirect URI shown there (it always matches your environment).

Redirect URI

https://api.nextgenmath.com/v1.0/canvas/oauth/initiate

Logo URL

https://cdn.nextgenmath.com/images/logo/215x215.png

Required OAuth scopes (enable all of the following when Canvas offers Enforce Scopes)

Group them in Canvas under Courses, Assignments, and Users as the UI allows. Include the Users/profile scope so student email addresses are available for assignee matching.

  • url:GET|/api/v1/courses
  • url:GET|/api/v1/courses/:course_id/assignments
  • url:POST|/api/v1/courses/:course_id/assignments
  • url:PUT|/api/v1/courses/:course_id/assignments/:id
  • url:GET|/api/v1/courses/:course_id/assignments/:id
  • url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
  • url:GET|/api/v1/courses/:course_id/students
  • url:GET|/api/v1/courses/:course_id/users
  • url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/overrides
  • url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/overrides
  • url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id
  • url:GET|/api/v1/users/:user_id/profile

Step 1: Start by logging into Canvas as the Canvas administrator.

Step 2: Navigate to the Admin page of Canvas and open the Developer Keys section.

Canvas Admin — Developer Keys

Step 3: Click the + Developer Key button in the top-right corner and select + API Key from the dropdown. This opens the API Key configuration page.

Canvas — + Developer Key, + API Key

Step 4: In the Canvas API Key form, enter the Redirect URI and Logo URL from the reference section above (or copy them from Next Gen MathSettingsIntegrationsCanvas API if your API host differs from production). Turn on Enforce Scopes and enable every scope listed above. Save the key in Canvas.

Canvas — API key configuration form

Step 5: After you click Save on the API key form, Canvas returns you to the Developer Keys list. You will see your new API developer key in the list (typically at the top). 

The new key may appear with State Off. You must enable the API developer key and set State to On before you copy the Client ID and Client Secret. OAuth from Next Gen Math will not work until the key is enabled.

Group 170.png

Step 6: Copy the Client ID from the Details column. You will need it to complete the Canvas API setup in Next Gen Math in the following section.

Group 171.png

Step 7: Open the key details and reveal the Client Secret. Copy the secret and keep it secure; you will enter it together with the Client ID in Next Gen Math.

Group 185.png

Step 8: In Next Gen Math, go to SettingsIntegrationsCanvas API. Enter:

  • Canvas instance URL — your Canvas base URL (for example https://<yourdistrict>.instructure.com)
  • Client ID — from Step 7
  • Client Secret — from Step 8

NOTE

Saving keys on the Canvas API page requires a NextGenMath.com account with the correct permission to manage your district’s Canvas integration. If you do not see Canvas API under SettingsIntegrations, contact us to request the permissions needed to manage your district’s Canvas integration on NextGenMath.com.

image 158.pngGroup 186.png

Click Save API key(s).

NOTE

Optional — more than one Canvas instance: On the Canvas API page, use Add key for another instance and repeat the Canvas key setup. Use Disconnect only when removing a key from Next Gen Math.

When the district status shows that the API developer key is configured, teachers can connect under SettingsIntegrationsMy integrations, then use Canvas on assignments for course linking and grade sync.

Group 187.png

 

Was this article helpful?
0 out of 0 found this helpful