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 Math → Settings → Integrations → Canvas 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
OAuth scopes (when using Enforce Scopes)
Enforcing scopes is recommended as an added layer of protection, but it is not required. You can leave Enforce Scopes off and skip this section if you prefer.
If you turn Enforce Scopes on, you must select and enable every endpoint listed below. Missing or incorrect scopes will cause the integration to fail.
Canvas organizes its scope selector into the same groups shown below. These are the groups you will see in Next Gen Math → Settings → Integrations → Canvas API, so you can work through one group at a time in Canvas and check it off here.
Courses
Lets Next Gen Math list your courses and read the course roster so assignments can be matched to students.
url:GET|/api/v1/coursesurl:GET|/api/v1/courses/:course_id/studentsurl:GET|/api/v1/courses/:course_id/users
Assignments
Lets Next Gen Math create and update the linked assignment, post scores, and manage due-date overrides.
url:GET|/api/v1/courses/:course_id/assignmentsurl:POST|/api/v1/courses/:course_id/assignmentsurl:PUT|/api/v1/courses/:course_id/assignments/:idurl:GET|/api/v1/courses/:course_id/assignments/:idurl:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_idurl:GET|/api/v1/courses/:course_id/assignments/:assignment_id/overridesurl:POST|/api/v1/courses/:course_id/assignments/:assignment_id/overridesurl:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:idurl:DELETE|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id
Users
Makes student email addresses available so course-roster members can be matched to Next Gen Math students. Without this group, assignee matching fails.
url:GET|/api/v1/users/:user_id/profile
That is 13 scopes in total. All of them must be enabled when Enforce Scopes is on.
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.
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.
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 Math → Settings → Integrations → Canvas API if your API host differs from production). Optionally turn on Enforce Scopes and enable every scope listed above. If you prefer not to enforce scopes, leave Enforce Scopes off. Save the key in Canvas.
NOTE
The Canvas scope selector can be difficult to use. We recommend using the Search endpoints box in the top right of the scope list. Search for each path (or a distinctive part of it), then select and enable the matching result. Be sure you enable the correct endpoints, or the integration will not work.
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.
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.
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.
Step 8: In Next Gen Math, go to Settings → Integrations → Canvas API. Enter:
-
Canvas instance URL — your Canvas base URL (for example
https://<yourdistrict>.instructure.com) - Client ID — from Step 6
- Client Secret — from Step 7
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 Settings → Integrations, contact us to request the permissions needed to manage your district’s Canvas integration on NextGenMath.com.
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 Settings → Integrations → My integrations, then use Canvas on assignments for course linking and grade sync.