Integrate MyDesign® with Canvas

This article will guide you through the process of integrating MyDesign with Canvas. You will learn how to add the MyDesign developer key to your Canvas account, add MyDesign at the account or course level, register your Canvas instance with the MyDesign platform, and then launch the MyDesign platform.

Add the MyDesign Developer Key

Open the Developer Keys settings for the root Canvas account and click the add Developer Key button. Be sure to select the LTI Key option.

Choose Enter URL for the Configure Method and enter https://mydesign.e4usa.org/api/lti/lti_config.json for the JSON URL, as well as a Key Name and an Owner Email of your choosing. Save when complete.

Toggle the key state to ON, and note the client id (“10000…001” in this example) and client key (Show Key), which you will need to add MyDesign to a course later in this guide.

Add MyDesign® as an external app

MyDesign can be added as an external app to a Canvas account, or to a course. This example shows how to add MyDesign to a course, but the same steps can be applied to an account (or sub-account).

Open Settings from the course navigation menu, select the Apps tab, and press the + App button.

Select By Client ID for the Configuration Type, and enter the developer key’s client id (which you previously noted). Submit to add the app.

Confirm that you want to install MyDesign by pressing the Install button.

You should now see a MyDesign link in the course navigation menu (you may first need to reload the course).

You will need to register Canvas with the MyDesign platform before this link will successfully open MyDesign.

Register Canvas with MyDesign®

To help us register your Canvas instance with the MyDesign® platform, you will be asked to provide the following information:

A descriptive name for your Canvas instance: (e.g. "Contoso HS Canvas")
The email address of a contact within your organization (generally the e4usa point person for your school or system)
The platform URL for your Canvas instance. This will generally be https://canvas.instructure.com.
Your school's Canvas URL (e.g. "contososchool.instructure.com")
The client id for the MyDesign Developer Key that you created previously
The client key (a.k.a. "client secret") for the MyDesign Developer Key

After providing us this information, we will inform you when your Canvas instance has been registered.

Test the Canvas integration

When you click on the MyDesign link in the course navigation menu, MyDesign should now load within Canvas.

As always, please email mydesign-support@e4usa.org if you have any questions or concerns.