Skip to main content
Help center

What can we help you with?

Search

Install the CodeAI Integration for Canvas

Note: Encountering issues with our new integrations? You can reach out to support via this link.

This guide is for users with administrator privileges who would like to install CodeAI's LTI 1.3 integration for Canvas LMS. This will allow your Canvas users to leverage our Single Sign-On and Roster Sync features. This process should take less than 5 minutes.

 

Video Walkthrough (Opens in New Tab)

 

Installing CodeAI for Canvas

Step 1: Create an LTI Key

Search for and add the CodeAI tool directly from the Canvas Apps page and proceed to Step 2.

Alternatively, can install the CodeAI tool from the Developer Keys page by following these steps:

  1. From the Canvas Admin menu, select Developer Keys
  2. Click the Add Developer Key button, and select the + LTI Registration option
  3. Enter the following URL: https://studio.code.org/lti/v1/dynamic_registration
  4. Supply your email address and click "Create Registration"
  5. Click "Enable and Close"

Step 2: Copy your ClientID

After creating your LTI Key, you will be redirected to your table of Developer Keys.

  1. Navigate to the CodeAI LTI Key you just created
  2. Ensure your LTI Key is enabled via the setting in the "State" column
  3. Copy the 18-digit numerical code under the "Details" column, e.g.: 000000000123456789 - this is your ClientID 

Step 3: Install the ClientID

Now that you have a ClientID, you can add the CodeAI integration to a Course - or globally for your LMS.

  1. Navigate to the Settings page of your Course, or your Admin settings if installing this integration globally
  2. Click the Apps tab
  3. Click View App Configurations
  4. Click the Add App button
  5. Select By Client ID in the Configuration Type drop-down menu
  6. Paste your Client ID copied from Step 3
  7. Click Submit
  8. Click the Install button to confirm your installation


Adding the LMS Integration to your Canvas Course

To install CodeAI in your Canvas course, first ensure the LTI Key is enabled from the admin panel. Next, select CodeAI from the External Tool dialogue when adding an Item to your App Modules. CodeAI must be configured to open in a new tab, and will not work in an iFrame.

 

Click the plus icon to add content to a module

 

Select "External Tool" and "Launch CodeAI" from the list (values will auto-populate)

 

Congratulations on installing the CodeAI LMS Integration for Canvas!

 

Frequently Asked Questions

Does the CodeAI Integration for Canvas create new CodeAI accounts?

On launching from Canvas, you have the option to create a new CodeAI account, or link to an existing account. If you create a new account via Canvas, you can still continue to use any existing accounts on CodeAI, even if they use the same email address.

 

I installed the CodeAI integration multiple times, which one should I use?

Please ensure that your Canvas implementation only has one CodeAI integration installed. When you click "Launch CodeAI" - a new account is created for you that is tied to the integration from which you launch. If you click "Launch CodeAI" on a new integration - a new account will again be created. At this time, merging these two accounts is not possible. You may of course, place the same CodeAI integration across your courses as many times as desired.

 

Can I sync my Canvas rosters to CodeAI?

Absolutely! Check out our roster syncing guide here.

 

Can I sync my CodeAI grades to Canvas?

Unfortunately this feature is not yet available.

 

I'm getting an error when I try to launch CodeAI

Most launch errors are from the CodeAI Integration not being installed correctly at the LMS level. Please work with your administrator to ensure the steps in the above article are completed. Or, contact us for help.

 

I'm getting a failed to load error on the CodeAI iFrame

iFrame placements are not currently supported. Instead, please ensure your External Tool is configured to open in a new tab. 

 

Does CodeAI support self-hosted instances of Canvas?

At this time CodeAI does not support self-hosted Canvas instances, only the production Canvas Cloud environment is supported.

 

I need more help!

If your questions are not covered in the above article, please contact us via this link.

 

 

Check out our other guides below to learn how to make the most of your integration:

Powered by Zendesk