English Español Français
Go to YuJa
  1. YuJa Help Center
  2. Lumina Video Platform
  3. Admin Panel
  4. LMS Platform Integration
  5. Instructure Canvas Integration

Integrating Instructure Canvas API into the Lumina Video Platform

Avatar
YuJa
  • Updated

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

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 Lumina.

  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.

    Instructure Canvas Guide 1.png

  3. Enter the information as shown below and then click Save.

    Enforces scope.png
  • Key Name: Canvas Auto Sync Key

  • Redirect URIs: https://<YOUR_YUJA_DOMAIN>/auth/Canvas

    • US Zone: https://panorama-api.yuja.com/canvas-auth
    • CAN Zone: https://panorama-api-cz.yuja.com/canvas-auth
    • EU Zone: https://panorama-api-ez.yuja.com/canvas-auth
    • AUS Zone: https://panorama-api-az.yuja.com/canvas-auth
    • (Optional) Enable Enforce Scopes.

    Note: We do not recommend enforcing scopes. It will require you to reintegrate Panorama with the Canvas API whenever Panorama adds new functionality that uses the API. If you do not want to proceed with this, please ensure that Enforce Scopes is disabled. 

    Recommended scopes: 

    Accounts
    url:GET|/api/v1/accounts
    url:GET|/api/v1/accounts/:id
    url:GET|/api/v1/accounts/:account_id/courses
    url:GET|/api/v1/accounts/:account_id/sub_accounts

    Admins
    url:GET|/api/v1/accounts/:account_id/admins

    Users
    url:GET|/api/v1/accounts/:account_id/users
    url:GET|/api/v1/users/:id/profile

    Roles
    url:GET|/api/v1/accounts/:account_id/roles

    Enrollments
    url:GET|/api/v1/courses/:course_id/enrollments

    Groups
    url:GET|/api/v1/courses/:course_id/groups
    url:GET|/api/v1/groups/:group_id/users

    Assignments
    url:GET|/api/v1/courses/:course_id/assignments
    url:GET|/api/v1/courses/:course_id/assignments/:id

  1. Toggle State to On and copy down the Canvas Client ID for later use.

    Instructure Canvas Guide 3.png

  2. Next, click Show Key and copy down the Canvas API Key for later use.

    Instructure Canvas Guide 4.png

Integrating Canvas API into the Video Platform

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

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

    The Video Platform featuring the Admin panel option from the Main menu icon.
  2. Click Integrations, then choose LMS API from the Select Integration drop-down list.
  3. Enter the following information, then click Save.
    • Choose an LMS: Canvas
    • URL Link to Your LMS: https://<YOUR_CANVAS_DOMAIN> (Refer to Step 3 in the previous section for domain zones.)
    • Client ID: Enter the Canvas Client ID from the above section.

    • Client Secret: Enter the Canvas API Key from the above section.

      Instructure Canvas Guide 6.png

  4. Click on Allow API Access.

    Instructure Canvas Guide 7.png

  5. While logged into Canvas as an admin, Select Authorize to allow Lumina to access the Canvas API.

    Instructure Canvas Guide 8.png

Managing Canvas API Calls

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

  1. Enable the desired options for Administrators to sync from Canvas into Lumina.

    Instructure Canvas Guide 9.png
    • 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 who 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.
    • Enable Canvas Sub-Account Synchronization: All Canvas sub-accounts associated with your organization will be imported to the video platform on a daily basis.
    • Start Synchronizations: Sync all the enabled options above from your Organization's Canvas into the Video Platform instantly.
  2. Click Save changes to apply all the changes.

Setting Up Canvas API Calls Notification 

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

  1. In the Notifications section, enter the YuJa User ID you would like to receive notifications through.

    Instructure Canvas Guide 10.png
  2. Click Save changes to apply all the changes.

Setting up Canvas API Linkage Settings

Administrators can configure Linkage Settings to provision courses and users from Canvas to the Lumina via the Canvas API. 

Instructure Canvas Guide 11.png

  1. Under Canvas Courses, check the Use Course Code and Term as backup fields if no Canvas Course ID is found box.

    Note: To only search Video Platform courses provisioned through LTI, check the Ignore non-LTI YuJa courses when syncing Canvas Courses box.

  2. Under Canvas Users, select the Primary Linkage Attribute from the drop-down menu.

  3. Check the Use user email and user's name as backup fields if no Canvas User ID is found box. 

    Note: To only search Video Platform users provisioned through LTI, check the Ignore non-LTI YuJa users when syncing Canvas Users box.

  4. Click Save changes to apply all the changes.

Related articles

Contact Support