Canvas Integration Overview

By connecting Canvas with Kyron, educators can enhance existing Canvas courses with Kyron lessons.

Requirements

Kyron Learning Account: Create a Kyron Learning account to access the platform's course creation tools. You need to be an admin in the organization you want to create lessons in.
Developer Key access on Canvas: Developer keys are configured on a per-account basis. This permission is generally only available to Canvas admins.

Create a Developer Key for Kyron

💡 Have you already created a key for LTI?

Unfortunately, the Developer Key used to configure LTI can’t be used here and you will need to create a separate key.

Configuration

1. Register Kyron with your Canvas account

A. Navigate to your Canvas account as an administrator and access the "Admin" tab.

B. Locate the "Developer Keys" section and click the "+ Developer Key" button.

C. Choose "API Key" from the dropdown menu and proceed to the configuration

page.

D. Fill in the form with the following values:

Field	Value
Key Name	Kyron Learning
Owner Email	support@kyronlearning.com
Redirect URIs	https://app.kyronlearning.com/auth/canvas/callback
Redirect URI (Legacy)	Leave blank
Vendor Code (LTI 2)	Leave blank
Icon URL	https://cdn.kyronlearning.com/logos/kyron-logo-book-purple.png
Notes	(Optional) Leave blank or include info to help identify this key in the future
Test Cluster Only	Leave unchecked
Client Credentials Audience	Leave as “Canvas”

E. Enforce scopes on the key by toggling on the “Enforce Scopes”

F. Check the box for “Allow Include Parameters”

G. Under “Courses”, enable the following endpoints:

url:GET|/api/v1/courses
url:GET|/api/v1/courses/:id

H. Under “Modules”, enable the following endpoints:

url:GET|/api/v1/courses/:course_id/modules
url:GET|/api/v1/courses/:course_id/modules/:module_id/items
url:POST|/api/v1/courses/:course_id/modules/:module_id/items

I. Under “Pages”, enable the following endpoints:

url:GET|/api/v1/courses/:course_id/pages
url:POST|/api/v1/courses/:course_id/pages

J. Click “Save” to create the key

K. In the “State” column, toggle the key to “Enabled”

The key should appear at the top of the list of Developer Keys in your Canvas account. Note the number in the “Details” column and the base64-encoded string behind the “Show Key” button. This is your Developer Key ID and Developer Key respectively which you’ll need in the next step.

2. Add your Canvas Developer Key to Kyron

Sign into Kyron and go to the “Settings & members” page
Click on “Integrations”
Under “Canvas OAuth”, fill in the following fields:
1. Canvas Host is the domain that you access Canvas on (usually canvas.<institution>.edu)
2. Canvas Client ID is the ID of your Canvas Developer Key (number that probably starts with 24)
3. Canvas Client Secret is base64-encoded string that is visible with the “Show Key” button in Canvas
Click “Save”

Note: If you don’t see “Canvas OAuth”, it probably hasn’t been enabled for your organization. Please reach out to support@kyronlearning.com for more info.