LMS - Canvas
Table of Contents
1. Overview
Ready Education integrates with Canvas through the Canvas API using calls made on behalf of the user. Ready Education integrates with the Canvas Rest API to obtain course data such as Grades, Discussions, Assignments, Quizzes, and Announcements.
In order to integrate with Canvas, Ready Education requires a Canvas AdminUtility Account with a specific set of required permissions. For both your Production and Test Canvas Instance, follow steps 1 - 3.
Step 1: Create a custom Ready Education Account Role
Step 2: Create Admin Account and apply custom Ready Education Account Role
Step 3: Create a Test User
2. Canvas Integration Requirements
Step 1: Create a custom Account Role
Ready Education requires an account role with specified permissions. You may either:
Recommended: Create a custom account role for Ready Education
Alternative: Add Ready Education to an existing account role with the required account permissions. For example, the Account Admin role.
How to Create a Custom Account Role
Open Permissions Panel: select Admin → Group → Permissions → Account Roles
On the right side, click Add Role, name as Ready Education Admin and save.
To add a permission, scroll to find the permission click on the red x → click Enable.
Add all the required Canvas Permissions for Ready Education.
Required Canvas Permissions
[ ] Announcements - view
[ ] Course Content - view
[ ] Grades - view all grades
[ ] SIS Data - read
[ ] Users - view list
[ ] Users - view primary email address
Step 2: Create Ready Education Canvas Admin and apply to custom Ready Education Account Role
The next step is to add a Ready Education Canvas Admin account to the newly created (or existing role) with the specified permissions.
Open the Settings Admin Panel:
On the left-hand panel: select Admin → Group (e.g. Ready Education University → Settings → Admins
Scroll to the bottom of the page, click + Account Admins
In Add More, select Ready Education Admin or Existing Role with required permissions (such as Account Admin).
Add account name and email address for Ready Education Admin as below:
Example: Ready Education Admin implementation@readyeducation.com
Click Continue
Note: If you choose to use an email other than implementation@readyeducation.com, please finish setting-up the Canvas Admin Account by accepting the email invitation and creating a password. You will need to share the email and password with your project manager.
IMPORTANT! For Test Canvas Instances, Canvas will not send out emails for registration. Please add the password manually in this case. Here's a short video on how to manually add a password.
You have now added Ready Education as a Canvas Admin and applied the correct role! You can continue to Step 3: Create Test User.
If you are unable to provide us with an admin user, you can provide us with a Canvas API Access Token, which is generated by a Canvas administrator under Account > Settings > Approved Integrations.
Step 3: Create Test User
Provide a test user account that can pass authentication, and has overlapping course data in both your SIS and LMS. Click here to view more information about our test user requirements: Test User and Test Data Requirements.
3. Provide the following information to your Technical Consultant
Provide the following information to your Technical Consultant by emailing integrations@readyeducation.com to create a ticket.
1. Canvas TEST Environment
[ ] Confirm the Canvas Permissions are set-up.
[ ] Provide username and password for Canvas admin user (you can use https://privnote.com/ to send the credentials securely).
[ ] URL for Canvas Instance (e.g. https://readyu.test.instructure.com/).
2. Canvas PROD Environment
[ ] Confirm the environments Canvas Permissions are set-up.
[ ] Confirm email for Admin Utility Account was sent to implementation@readyeducation.com or share login credentials for Canvas Admin Utility Account (you can use https://privnote.com/ to send the credentials securely).
[ ] URL for Canvas Instance (e.g. https://readyU.instructure.com).
3. Test User
[ ] Send login credentials for Test User with courses data and ability to pass SSO (you can use https://privnote.com/ to send the credentials securely).
[ ] Confirmation of which environment the test user is setup in (TEST and/or PROD).
[ ] Confirmation of which courses the student is enrolled in and what course data has been added.
You’re all set! Your Implementation Consultant will initiate integrations development for your Canvas Test and/or Production environments.
Appendix A: Canvas Admin Account Permission Details
As part of the Canvas Integration in your Campus App, you are required to provide Ready Education with a Canvas utility account (i.e. admin user account). This account is used by the Ready Education Activations team and developers to create API tokens, which are then used in the development of our native integration for your mobile app.
The Canvas Utility Account requires the following permissions. The list below includes details about the permissions and how they are used by Ready Education during the integrations development.
Announcements - view
Allows user to view the Announcements link in Course Navigation and view the announcements.
Course Content - view
Allows user to view published and unpublished course content.
Grades - view all grades
Allows user to search by assignment ID in grade change logs.
Allows user to view student-specific data in Analytics.
Allows user to view a link to SpeedGrader from assignments.
Allows user to export the Gradebook to a comma separated values (CSV) file.
Allows user to access the Learning Mastery Gradebook (if enabled).
Allows user to view student Grades pages.
Allows user to access the Student Progress page.
Allows user to view analytics link in the user settings menu.
Allows user to view student results, view quiz statistics, and access a quiz in SpeedGrader.
Allows user to view grader comments on a rubric in SpeedGrader.
Adds analytics to a student’s context card.
SIS Data - read
Allows user to view a course’s SIS ID.
Allows user to view the SIS ID in a user’s login details.
Allows user to view user SIS IDs in a course People page.
Allows user to view the user SIS ID column in the Quiz Item Analysis CSV file.
Governs account-related SIS IDs (i.e., subaccount SIS ID).
Users - view list
Allows user to access the People link in Account Navigation.
Allows user to view login/logout activity of users in Admin Tools.
Allows user to search grade change logs by grader or student in Admin Tools.
Allows user to differentiate assignments to individual students.
Allows user to view and add users in a collaboration.
Allows user to send a message in Conversations without selecting a course.
Allows user to view the People link in Course Navigation.
Allows user to view groups in a course.
Allows user to view list of users in the account.
Allows user to view list of users in the course People page.
Allows user to view the Prior Enrollments button in the course People page.