How to set up a Canvas API and LTI Integration for Tech Admins *Beta*

A Step-by-Step Guide to Integrating SchoolAI with Canvas LMS

Please note: The Canvas integration through API and LTI is currently in beta mode and is being tested before full implementation. It may not be available to all users.

Connecting your Organization with Canvas

A Canvas Integration allows SchoolAI to create and recommend AI-powered chat experiences that closely align with each teacher’s course content. It also allows teachers to send their content from SchoolAI directly to Canvas.

1. From your SchoolAI settings page, navigate to Integrations > Organization Integrations. This option is only available for SchoolAI Admins. If you need Admin access, please contact our support team. To add an integration, click "Add Integration" in the top right corner and select "Canvas."
   

Connect Canvas API

Canvas will create a Client ID and Key that you will share with SchoolAI to make a connection.

1. Sign in to Canvas and navigate to the Admin tab and then Developer Keys in the sub-menu.
   
2. Click "+Developer Key" and select API Key from the dropdown.
   
3. Enter "SchoolAI" as the Key Name, your email in the Owner Email field, and paste the following link into the Redirect URIs field: https://app.schoolai.com/api/canvas-callback
   
4. Once those fields are complete, click the "Save" button in the bottom right corner.
   
5. You should now see a new developer key showing in Canvas. Make sure that the state is set to 'Active.'
   
6. Copy the Client ID from the details column and paste it into the Client ID field in SchoolAI.
   
7. Return to Canvas and click the "Show Key" button in the details field. Copy the key and paste it into the Client Key field in SchoolAI.
   
8. Click the "Connect" button on the bottom. This will open a new page.
9. Click "Authorize." Once that's done, you will then be redirected back to SchoolAI and you'll be ready for the next step.
   

LTI Registration

Once your API key is set up successfully you can set up the LTI connection by sharing your dynamic registration URL to Canvas.

1. In Canvas, return to Admin>Developer Keys.
   
2. Click "+ Developer Key" and select LTI Registration from the dropdown.
   
3. Return to SchoolAI and copy the Dynamic Registration URL.
   
4. Paste your dynamic registration URL into the Canvas window and then click "Continue."
   
5. You may need to wait a moment for the next page to load. Once it does, click "Enable & Close" in the bottom right corner.
   

Add an App Configuration

With your new LTI registration information, we'll add an external app configuration.

1. Copy the SchoolAI LTI Client ID from the details column of the newly created SchoolAI Developer Key. Please note that you will have SchoolAI Client IDs for both the API and an LTI. You need the LTI Client ID for the app configuration. The LTI row should include the SchoolAI logo.
   
2. Navigate to the Settings page within the Admin sub-menu in Canvas.
   
3. Open the Apps tab and click on the "View App Configurations" button.
   
4. Click on the "+ App" button in the top right corner.
   
5. Under the Configuration Type dropdown, select "By Client ID."
   
6. Paste the Client ID from step 1 and click "Submit."
   
7. On the Add App screen, click "Install" on the bottom of the window.
   
8. Once completed, return to SchoolAI and click "Test connection." Please note that it can take 5-20 seconds for the app to successfully register. If you click the button and get an error, please click the "Test connection" button again until the modal auto-closes.
   

Congratulations! You have successfully linked Canvas with SchoolAI.