Setting up an integration between EP and Canvas

Adding support for Canvas is a straightforward process, which normally requires a couple of hours of work by your school's IT team/LMS manager. Education Perfect's integration may differ from other integrations your school has because we need a way to match a Canvas user to their EP account. This enables us to include the work they do in Canvas in their learning record when teachers are writing reports and running parent/teacher interviews.

Get in touch with us

To get started, get in touch with our team. If you're not the person who will be configuring the integration, please also include them in the email so we know who to contact with the next steps. Our team will send you a consumer and secret key pair which you can use to authenticate with us. Please let us know that you wish to integrate with Canvas!

Install the App

If you haven't added a new app before, see Canvas' help documentation. Please note that you can install External Apps on a per course basis, or across an entire account giving all courses access to the App. To install Education Perfect across an entire Account select that account from the Admin menu, then follow the instructions from the above link using that Account's Settings menu for the account. To add Education Perfect to individual courses one at a time select the course you would like to add it to then proceed with the instructions using it's Settings menu

If you get a 405 (Method Not Allowed) error, this is normally caused by configuring the app manually instead of by URL. For more information, see How do I resolve a 405 (Method Not Allowed) error when configuring a Canvas integration?

Testing out the integration

Now that the integration has been set up, try to add something to a course in Canvas using our help guide here. We expect an error to show up stating that your account could not be found. This is perfectly normal and part of the process!

Please screenshot this error and send it to us, as the information included in this will let us know what the expected identifier format is for Canvas, usually it is an email address but not always depending on your set up.

Match existing users to their Canvas accounts

If your students have already been using Education Perfect without a Canvas integration, their EP accounts will need to be linked to the unique identifier Canvas uses to confirm their identity. This enables any work that students do on Education Perfect in Canvas to be stored against their account. Often this is the user's school email address, but it can differ from school to school - the information in the error message given above helps us to work out exactly what to use.

If we already have the unique identifier associated with teachers' and students' accounts, for example, because it's their email addresses, we'll match up everyone we can on your behalf. We will then send you a list of anyone we couldn't match. Once you send us the details for those people, we'll update them as well.