Setting up the Canvas Integration with USATestprep - Canvas Admin
Updated 6 months ago
by
DaCota Cole
To integrate your district with Canvas, we need three things from the data admin:
- Client ID
- Client secret
- Endpoint URL
All of this information can be found in the admin section of your Canvas account with the exception of the endpoint URL. This is usually something like 'mydistrict.instructure.com'.
Step 1:
Navigate to the admin section and select the developer keys link in Canvas.
Step 2:
Select the blue ‘+ Developer Key’ button at the top right of the page. Select the API Key option.
Step 3:
Enter the Key Name (USATestprep), Owner Email, & Redirect URI (Legacy). The Legacy Redirect URI will be https://www.usatestprep.com.
Step 4:
Select the ‘Enforce Scopes’ toggle near the top center of the page.
Step 5:
Search for and check the box to the left of each of the following scopes:
Courses:
- url:GET|/api/v1/courses
- url:GET|/api/v1/courses/:course_id/students
- url:GET|/api/v1/courses/:course_id/users
Enrollments:
- url:GET|/api/v1/courses/:course_id/enrollments
Assignments:
- url:GET|/api/v1/courses/:course_id/assignments
- url:GET|/api/v1/courses/:course_id/assignments/:id
- url:POST|/api/v1/courses/:course_id/assignments
- url:PUT|/api/v1/courses/:course_id/assignments/:id
- url:DELETE|/api/v1/courses/:course_id/assignments/:id
Submissions:
- url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
- url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
- url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
Sections:
- url:GET/api/v1/courses/:course_id/sections
- url:GET/api/v1/courses/:course_id/sections/:id
- url:GET/api/v1/sections/:id
Step 6:
After the scopes for the API have been enabled, click the “Save” button at the bottom right of the page.
Step 7:
Now that you have successfully set up your developer key, you can locate the information that our Customer Support team will need to set up the integration on our end. You can send this information to support@usatestprep.com to complete the integration setup.
Client ID:
Client Secret:
Endpoint URL = "mydistrict.instructure.com"
This can also be located in the URL of your web browser.
Step 8:
Select the ON button below the state column.
Congratulations, you're now ready to send the required information to support@usatestprep.com so that we can setup the integration for teachers to get started using Canvas with USATestprep!
