English Español Français
Go to YuJa
  1. YuJa Help Center
  2. Panorama LMS Accessibility Platform
  3. Canvas Integration
  4. Administrators

Integrating Panorama into Canvas Using LTI 1.3

Avatar
YuJa
  • Updated

This document provides admins with instructions on integrating the Panorama Platform into Canvas using LTI 1.3. Before proceeding with the steps below, please ensure you have full access to your Canvas instance as an admin. If you have questions about the process, please contact your dedicated Client Success Manager.
 

Note: It is strongly recommended to create a separate service account in Canvas for the integration. This makes it easier to identify which actions were performed by the integration and which were performed by a human admin, helping prevent confusion or unintended changes.

 

Obtaining Your Panorama JSON String

Before adding Panorama to your Canvas instance, you will need to obtain your JSON string. To access your JSON string, you will need to have received an email from your Client Success Manager asking you to sign up for your Panorama account. Sign up for your account, and then proceed with the steps below. 

  1. Log in to your Panorama Account.
  2. Click Configurations from the left-side menu, and then select Integration Settings.
  3. Select LTI 1.3.
  4. Click Download LTI 1.3 JSON to obtain your Panorama JSON String. 

Adding Panorama to Canvas

Once you've obtained your JSON string, you can add Panorama to your Canvas instance. 

  1. Log in to Canvas as an admin. From the left sidebar, click on Admin, and select the Canvas account for your institution.
  2. In the sidebar, select Admin > Developer Keys.
  3. Click + Developer Key > + LTI Key.
  4. From the Method drop-down menu, select Paste JSON.
  5. Open the JSON file downloaded in the previous section in any text editor, such as Notepad, and copy its content. The Redirect URLs will be automatically added.
  6. Next, paste the copied content into the LTI 1.3 Configuration field.

  7. Provide a Key Name of your choice, and click Save.

    Note: If you want the LTI tool to be disabled on the course navigation bar by default, add the following parameter in the section for the course navigation - "default": "disabled".

    The parameter to set the Panorama LTI link is inserted in the code.

  8. Enable the Developer Key State toggle.
  9. Click View in Canvas Apps. A new Canvas window will be opened.
  10. Click the pencil icon.
  11. Change the status to Available, then click Save. Proceed to Generating a Client Key and Secret to complete the integration. 

     
     

Generating a Client Key and Secret

  1. Click + Developer Key > API Key.
    1.png

  2. Enter the following information:

    • Key Name: Panorama API Integration
    • Redirect URls: https://<zoneURL>/canvas-auth
      • 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

    2.png

  3. (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, then proceed to step 7. 
  4. Check Allow Include Parameters and then check the following parameters:
    3.png
    • 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
    • Assignments
      • url:GET|/api/v1/courses/:course_id/assignments
      • url:GET|/api/v1/courses/:course_id/assignments/:id
      • url:PUT|/api/v1/courses/:course_id/assignments/:id
    • Courses
      • url:GET|/api/v1/courses
      • url:GET|/api/v1/courses/:id
      • url:GET|/api/v1/courses/:course_id/users
      • url:GET|/api/v1/courses/:course_id/users/:id
      • url:PUT|/api/v1/courses/:id
      • url:POST|/api/v1/courses/:course_id/files
    • Discussion Topics
      • url:GET|/api/v1/courses/:course_id/discussion_topics
      • url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id
      • url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id
      • url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id
    • Enrollments
      • url:GET|/api/v1/users/:user_id/enrollments
      • url:GET|/api/v1/courses/:course_id/enrollments 
    • Enrollment Terms
      • url:GET|/api/v1/accounts/:account_id/terms
      • url:GET|/api/v1/accounts/:account_id/terms/:id
    • Files
      • url:GET|/api/v1/courses/:course_id/files
      • url:GET|/api/v1/files/:id
      • url:POST|/api/v1/files/:id
      • url:PUT|/api/v1/files/:id
    • Pages
      • url:GET|/api/v1/courses/:course_id/pages
      • url:GET|/api/v1/courses/:course_id/pages/:url_or_id
      • url:PUT|/api/v1/courses/:course_id/pages/:url_or_id
      • url:POST|/api/v1/courses/:course_id/pages
    • Quizzes
      • url:GET|/api/v1/courses/:course_id/quizzes
      • url:GET|/api/v1/courses/:course_id/quizzes/:id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes
      • url:PUT|/api/v1/courses/:course_id/quizzes/:id
      • url:PATCH|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
    •  Roles
      • url:GET|/api/v1/accounts/:account_id/roles
      • url:GET|/api/v1/accounts/:account_id/roles/:id
    • Rubrics
      • url:GET|/api/v1/courses/:course_id/rubrics
      • url:GET|/api/v1/courses/:course_id/rubrics/:id
    • LTI Resource Links
      • url:GET|/api/v1/courses/:course_id/lti_resource_links
      • url:GET|/api/v1/courses/:course_id/lti_resource_links/:id
  5. Click Save.
    4.png
  6. Locate the newly created Panorama API Integration developer key and copy the Client ID under Details.
  7. Click Show Key and copy the Client Secret.
  8. Log in to Panorama, then from the left-side menu, click Configuration > Integration Settings.
    7.png
  9. From the Select Integration drop-down menu, select LMS API.
  10. Click Add Access Key.
    9.png
  11. For the Canvas Authentication Method, choose Client ID.
  12. In the Client ID field, enter the ID from step 8.
  13. In the Client Secret field, enter the client secret from step 9.
  14. If you used enforced scopes, enable Use Enforced Scopes. Otherwise, skip this step.
  15. Click Authenticate With Canvas.
    Note: Please ensure you are logged in to Canvas as an admin with full privileges.
  16. Click Authorize.
    13.png
  17. Copy the authentication response and go back to Panorama. Paste the response in the Canvas Authentication Response field.
  18. Click Add Access Key.
  19. Click Save Changes to complete the setup.
    15.png

Installing the LMS Visualizer 

Installing the LMS visualizer will allow Panorama's icons to appear within courses. This step requires your Canvas instance to have the Custom CSS/JavaScript Overrides feature enabled. If it is not enabled, please contact your Canvas Account Manager.

  1. Log in to Panorama.
  2. Click Configurations from the left-side menu, and then select Integration Settings.
  3. From the Select Integration drop-down menu, choose LMS Visualizer and click Download Visualizer.
  4. Next, log in to Canvas as an Admin. From the left sidebar, click on Admin and select the Account to apply the YuJa Panorama - LMS Viewer.
  5. Select Settings from the left-hand navigation bar, and ensure that the settings tab is selected from the top row. 
  6. Next, click on Themes from the left-hand navigation bar, then click the + Theme button. Select any theme template from the drop-down.
  7. In the theme editor, go to the Upload tab, and select the Visualizer file that was downloaded. Important: The Upload tab is only available once your Canvas Account Manager enables it.
  8. Next, click Preview Your Changes, and then choose Apply Theme. When asked to give your theme a name, type in Panorama Theme.

Related articles

Contact Support