How do I integrate Coursetune with Canvas? – Coursetune Support

For Canvas LTI 1.3, please follow these instructions instead.

Also answers:

Can I pair Canvas and Coursetune?
Does Coursetune integrate with my LMS?

Who can do this? Coursetune Admins who are also Canvas Admins

For more information, read these articles:

Coursetune LMS integration is constantly evolving and improving. Watch for release notes on latest updates.

*If Canvas is not your LMS, consider using our APIs to integrate Coursetune data into any system.

To set up Coursetune in your Canvas instance, you must be an admin in both accounts.

You will follow these three steps, with Step 4 and 5 being optional:

Step 1: Creating Developer Key and Developer Account ID
Step 2: Insert Developer Key and Developer Account ID in Coursetune
Step 3: XML Configuration
Step 4: Rich Text Editor
Step 5: Disabling the Coursetune Navigation Link From Showing in All Courses by Default

"We really wanted it to be something that the teachers felt comfortable with. The integrations with Canvas, for example, that it can just pop into your Canvas course while you're developing your actual course. You can see your Coursetune map right there. All of those things were just important to make sure that faculty felt engaged with it and not just top-down on them."

-Lexi Fields, Director of Teaching and Learning, The Galloway School

Step 1: Creating Developer Key and Developer Account ID

It is important to note that Canvas does not allow developer keys to be created for specific Canvas subaccounts. You will be doing the integration at the main level of your account. If you wish to hide the Coursetune navigation link from being the default in all courses, and enable it for specific courses, you will be able to do that following step 5.

This integration doesn't require a scoped developer key, but Canvas does recommend using one. Here is a link to Canvas documentation on how to create a scoped developer key.

*Note: If you have scoped the key and get errors on accessing tokens, please try unchecking all of the end points and saving. Then, re-check the end points and save. Sometimes if the server glitches while checking the scopes, one or two don't get saved in the Canvas back-end.

Your contract will have available API endpoints documented for your instance. You can also download a file of the endpoints at the end of this article.

*Note: If you are trying to export a course from Catalyst into Canvas, you can NOT enforce scopes in the developer key, yet. This is known, and we will be working to get a full list of scopes for Catalyst use, soon.

Open both Canvas and Coursetune in separate tabs and keep them open.

(1) In Canvas, click the Admin panel on the left side and select Developer Keys within your account menu.

(2) Click plus +Developer Key to access the Key Setting panel and name your key. .

(3) Choose plus +API Key

Now, go to your Coursetune tab.

(4) From the top bar, select the hamburger menu.

(5) From the drop down menu, select Integrations.

Note: If you do not see hamburger menu in the top bar, then you do not have admin access to Coursetune and will need to request it from another Coursetune admin.

(6) Select Canvas Integration from the left drop down menu and keep this page open. You will be copying elements from this Coursetune page into Canvas, and from Canvas into this page in Coursetune.

(7) Be sure to name your Canvas Developer Key to Coursetune.

(8) The first component to copy from Coursetune into Canvas are the Redirect URIs. Copy the URIs from the top of the Canvas Integration panel in Coursetune, switch to the Canvas tab and paste them into the Redirect URIs text field in Canvas.

(9) Click Save in Canvas to generate the Developer Account ID. Coursetune should now appear in your list of Developer Keys. Make sure the Key State is On.

Keep your Canvas Admin browser tab open for Step 2.

Step 2: Insert Developer Account ID and Key in Coursetune

Next you will enter your newly created Developer Account ID number and Developer Key in Coursetune Admin Settings. Switch to your Coursetune tab.

(1) In the Coursetune Canvas Integration settings panel, fill in Developer ID and Developer Key with the Developer Account ID and Developer Key you generated in Canvas.

(2) Now, populate the Platform Domain with your institution's Canvas URL.

For example, institution.instructure.com

*Be sure to leave "http" or "https" off of the Platform Domain.

Click Save. Keep this Coursetune page open so that you can come back to it in Step 3.

Step 3: XML Configuration

For this step, go back to your Canvas account.

(1) From the Canvas Admin panel, select Settings

(2) Click on the Apps tab

(3) On the Apps tab, select View App Configurations.

(4) Click on plus +App to open the Add App window.

(5) Select Paste XML from the Configuration Type drop down menu.

(6) Name your app Coursetune.

Now, navigate back to your Coursetune Canvas Integration Settings panel

(7) Find Consumer Key, Shared Secret, and XML Configuration.

(8) Copy and paste those three items into the correct fields in your Canvas Add App window.

NOTE: If you want to disable the Coursetune navigation link from showing in all Canvas courses by default, please scroll to Step 5: Disabling the Coursetune Navigation Link From Showing in All Courses by Default and follow the steps there. Once you click Submit in this step, you will be unable to edit the XML, and would need to redo this step of the integration completely.

Click Submit. Canvas will notify you if your app was successfully added or not.

You will now see Coursetune listed in your Canvas Admin Settings Apps tab, and your Canvas users will see Coursetune as an option in their course menu.

Now, faculty and staff will be able to access Coursetune. They can link their Canvas course to their Coursetune course (level-4 object), edit their Coursetune course while in Canvas, and push a course from Coursetune into their Canvas course.

Here are some instructor-facing directions to share:

Step 4 (optional): Adding the Rich Text Editor

Optionally, you may choose to add the Rich Text Editor (Coursetune RTE) tool to your Canvas account.

Refer to this article: How do I install the Rich Text Editor plugin in Canvas?

Step 5 (optional): Disabling the Coursetune Navigation Link From Showing in All Courses by Default

You may not want all faculty members to see the Coursetune navigation link in all courses. You may only want to enable the link for certain faculty members and their courses. This can be done by changing a word in the XML Configuration text when you are on Step 3: XML Configuration (point 8 in the screenshots).

When you copy the XML text from with the Coursetune Canvas Integration panel, you will paste that into the XML text field. When you do that, you will need to change the word 'enabled' to 'disabled' in this line of the code (located towards the bottom of the code):

<lticm:property name="default">enabled</lticm:property>

You will need to change enabled to disabled, like this:

<lticm:property name="default">disabled</lticm:property>

When you have done this, you can click on Submit.

In order to enable the Coursetune navigation link in certain Canvas courses, start by navigating to your Canvas course (1), and click Settings from the left-hand navigation (2).

CANVAS

In the Settings panel, click on the Navigation tab (3). Under the 'Drag items here to hide them from students' header, look for the Coursetune navigation link, and click on the ellipses (4). Select Enable (5).