Integrating Instructure Canvas API into YuJa Enterprise Video Platform

Administrators can integrate the Instructure Canvas API and automatically sync all the information from Canvas to the YuJa Enterprise Video Platform. This document provides instructions on how to integrate the Canvas Instructure API into the Video Platform.

Generating Canvas Client ID and API Keys

The instructions below will allow users to generate a new Canvas Client ID and API Key that can be used to integrate into the Video Platform.

1. Log into Canvas as an Admin.
2. Navigate to the Admin tab and choose Developer Keys. Click the + Developer Keys button and select + API Key.
   

   

3. Enter the information as followed.
   

   

• Key Name: Canvas Auto Sync Key
• Redirect URIs: https://<YOUR_YUJA_DOMAIN>/auth/Canvas
4. If your Organization uses Enforced Scopes, make sure to have the following scopes enabled.
• Accounts > url:GET|/api/v1/accounts
• Accounts > url:GET|/api/v1/accounts/:account_id/courses/
• Users > url:GET|/api/v1/accounts/:account_id/users
• Users > url:GET|/api/v1/users/:user_id/profile
• Admins > url:GET|/api/v1/accounts/:account_id/admins
• Enrollments > url:GET|/api/v1/courses/:course_id/enrollments
• Groups > url:GET|/api/v1/courses/:course_id/groups
• Groups > url:GET|/api/v1/groups/:group_id/users
5. Update State from Off to On and copy down the Canvas Client ID for later use.
   

   

6. Click Show Key and copy down the Canvas API Key for later use.
   

   

Integrating Canvas API into the Video Platform

The next steps involve integrating the newly obtain Canvas API Key into the Video Platform.

1. Log into the Video Platform as an Admin, then go to the Admin Panel.
   

   

2. From the left navigation menu, click on Integrations then choose LMS API under the Select an API to Configure dropdown list.
   

   

3. Enter the following information, then click Save.
   

   

• URL Link to Your LMS: https://<YOUR_CANVAS_DOMAIN>
• Choose an LMS: Canvas
• App ID: Paste in the Canvas Client ID from the above section.
• Key ID: Paste in the Canvas API Key from the above section.
4. Click on Allow API Access.
   

   

5. Select Authorize while logged in to Canvas as an Canvas Administrator to allow the Video Platform to access the Canvas's API.
   

   

Managing Canvas API Calls

With the Canvas API setup, the Administrators will now have the ability to customize which information to sync from Canvas into the Video Platform. In general, we recommend that institutions turn on all Synchronization Actions to take advantage of this functionality.

1. Below are the available options for Administrators to sync from Canvas into the Video Platform.
   

   

   • Enable Canvas Course Synchronization: All courses from your Organization's Canvas will be synced to the Video Platform on a daily basis.
   • Enable Canvas User Synchronization: All users from your Organization's Canvas that are enrolled in a Canvas course will be synced to the Video Platform on a daily basis. For users who hold two different roles in Canvas, the Video Platform will provision the higher role. 
   • Enable Canvas Enrollment Synchronization: All new user enrollments from your Organization's Canvas will be synced to the Video Platform on a daily basis.
   • Enable Canvas Accommodated Groups Synchronization: All Canvas Accommodated Groups from your Organization's Canvas will be imported to the Video Platform on a daily basis.
   • Start Synchronizations Now: Sync all the enabled options above from your Organization's Canvas into the Video Platform instantly.
   • Stop Ongoing Synchronization: Stop an active, on-demand sync started with Start Synchronization Now.
2. Once done, click Save to apply all the changes.

Setting Up Canvas API Calls Notification 

Administrators can choose to set up a user to receive all the Canvas API call notifications.

1. Under Notifications, enter a YuJa User ID that you wish to receive all the notifications from Canvas API Calls.
   

   

2. Once done, click Save to apply all the changes.

Setting up Canvas API Linkage Settings

Administrators can configure the linkage attributes used to provision courses and users from Canvas to the Video Platform via the Canvas API.