English Español Français
Go to YuJa
  1. YuJa Help Center
  2. Verity Test Proctoring Platform
  3. Integrations

Integrating the YuJa Verity Test Proctoring Platform into Canvas

Avatar
YuJa
  • Updated

This document provides admins with instructions on integrating the Verity Test Proctoring 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 Account 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.

 

Adding Verity to Canvas

As an admin, you can integrate Verity with Canvas by adding a JSON URL to the Developer Keys.

  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. In the Key Settings page, enter a name for your key (e.g., YuJa Verity).
  5. From the Method drop-down menu, select Enter URL.

  6. In the JSON URL field, enter one of the following URLs depending on your location: 

    US Zone: https://zone1.verity.yuja.com/api/verity/lti/config/canvas.json 

    AUS Zone: https://az.verity.yuja.com/api/verity/lti/config/canvas.json 

  7. Click Save.
  8. In the Developer Keys page, locate the Verity key that you have added.
  9. Ensure that the toggle for the State field is ON. If the Turn On Developer Key pop-up appears, click Switch to On. 
  10. Click View in Canvas Apps. A new Canvas window will be opened.
    toggle and view in canva app.png

  11. Click Unlock app.

  12. In the pop-up, click Unlock.

  13. Next, click the Modify availability (pencil) icon. 
  14. Change the status to Available, then click Save. Proceed to Generating an API key secret to complete the integration.

Generating an API key secret

  1. Click + Developer Key > API Key.
    API key.png
  2. Enter the following information:
    • Key Name: Verity API Integration
    • Redirect URls: https://<zoneURL>/api/verity/oauth/callback
      • US Zone: https://zone1.verity.yuja.com/api/verity/oauth/callback
      • AUS Zone: https://az.verity.yuja.com/api/verity/oauth/callback

  3. (Optional) Enable Enforce Scopes.
    Note: We do not recommend enforcing scopes. It will require you to reintegrate Verity with the Canvas API whenever Verity adds new functionality that uses the API. Additionally, if scopes are enabled, the Verity Mobile Lockdown App will not be supported. If your institution uses the Verity Mobile Lockdown App, it is required that scopes be disabled. 

    If you do not want to proceed with this, please ensure that Enforce Scopes is disabled, then proceed to step 5. 

  4. Check Allow Include Parameters and then check the following parameters:
    • Accounts: 
      • url:GET|/api/v1/accounts
      • url:GET|/api/v1/accounts/:id
      • url:GET|/api/v1/manageable_accounts
      • url:GET|/api/v1/course_creation_accounts
      • url:GET|/api/v1/course_accounts
      • url:GET|/api/v1/accounts/:account_id/sub_accounts
      • url:GET|/api/v1/accounts/:account_id/permissions
      • url:GET|/api/v1/accounts/:account_id/courses
    • Assignments: 
      • url:GET|/api/v1/courses/:course_id/assignments
      • url:GET|/api/v1/courses/:course_id/assignments/:id
      • url:POST|/api/v1/courses/:course_id/assignments
      • 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/accounts/:account_id/courses/:id
      • url:GET|/api/v1/users/:user_id/courses
      • url:GET|/api/v1/courses/:course_id/users
      • url:GET|/api/v1/courses/:course_id/users/:id
    • External Tools: 
      • url:GET|/api/v1/courses/:course_id/external_tools/:external_tool_id
      • url:GET|/api/v1/courses/:course_id/external_tools
      • url:GET|/api/v1/courses/:course_id/external_tools/sessionless_launch
      • url:GET|/api/v1/accounts/:account_id/external_tools/sessionless_launch
    • New Quiz Items: 
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items/:item_id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items
      • url:POST|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items
      • url:PATCH|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items/:item_id
    • Quizzes: 
      • url:GET|/api/v1/courses/:course_id/quizzes
      • url:GET|/api/v1/courses/:course_id/quizzes/:id
      • url:POST|/api/v1/courses/:course_id/quizzes
      • url:PUT|/api/v1/courses/:course_id/quizzes/:id
      • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
      • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
      • url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
      • url:PUT|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
      • url:POST|/api/v1/courses/:course_id/quizzes/:id/validate_access_code
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes
      • url:POST|/api/quiz/v1/courses/:course_id/quizzes
      • url:PATCH|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
    • Quiz Questions: 
      • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
      • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
      • url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
      • url:PUT|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
    • Users: 
      • url:GET|/api/v1/users/:id
      • url:GET|/api/v1/accounts/:account_id/users

  5. Click Save in the bottom right corner.

  6. Copy the API Key secret that appears in the Developer Key Created pop-up, then click Close.

  7. Ensure the State toggle for the newly added API key is enabled.

  8. Contact your Account Manager with your API Key secret to finalize the LMS configurations for Verity.

Testing YuJa Verity's API access

Once your Account Manager completes the integration, you can test the REST API to ensure instructors can delete Verity quizzes and create Verity practice quizzes in Canvas.

  1. In Canvas, click the YuJa Verity link in the sidebar to open the Verity portal.
  2. In Verity, select Settings > Integration Settings from the side navbar.
  3. Select LMS API in the Select Integration drop-down menu.
  4. In the Access Keys section, click Test Institution Access to verify that your Canvas account is integrated with the API.
    The Select Integration and Access keys field are highlighted.
  5. Confirm that your API access is successful for both Read Accounts and Read Courses access.
    Note: If your API access fails, please contact your Account Manager to update the API key for your institution.
  6. Click Close.
    The Test API Access pop-up window.

Adding the LMS visualizer to Canvas

As an admin, you can add JavaScript code within the Theme Editor to monitor the Verity Browser extension. With the JavaScript code enabled, test-takers will be guided to download the Verity Browser Extension before accessing the assessment. They will not be able to access the assessment unless the Browser Extension is installed.  

  1. In Canvas, click the YuJa Verity link in the sidebar to open the Verity portal.
  2. In Verity, select Settings > Integration Settings from the side navbar.
  3. Select LMS Visualizer in the Select Integration drop-down menu.
  4. Click View Visualizer.
    The LMS Visualizer is selected.
  5. Copy the JavaScript code that appears in the new tab. 
  6. Within Canvas, select Themes from the side navbar.
  7. Hover over your theme, and click Open in Theme Editor.
    The Themes section is selected from the side navbar in Canvas.
  8. From the left panel, click the Upload tab.
  9. Locate the JavaScript file field, then click View File to open the JavaScript code page.
    The View File button is highlighted.
  10. Right-click on the JavaScript code page and select Save as to save the file to your device. 
    Saving the JavaScript code as a new file.
  11. Open your file within a text editor (e.g., Notepad), and paste the JavaScript code copied in step 5 at the end. 
    Adding the copied JavaScript code to the file.
  12. Save your file in your text editor. 
  13. Within your Theme Editor, locate the JavaScript file field and click Select to upload your file. 
    The select button is highlighted in the JavaScript file field.
  14. Locate the Mobile app JavaScript file field, then click View File to open the JavaScript code page.
    The View File button is highlighted in the Mobile app JavaScript file field.
  15. Right-click on the JavaScript code page and select Save as to save the file to your device. 
    Saving the JavaScript code as a new file.
  16. Open your file within a text editor (e.g., Notepad), and paste the JavaScript code copied in step 5 at the end. 
    Adding the copied JavaScript code to the file.
  17. Save your file in your text editor. 
  18. Within your Theme Editor, locate the Mobile app JavaScript file field and click Select to upload your file.
    The select button is highlighted in the Mobile app JavaScript file field.
  19. Click Preview Your Changes.
    The preview your changes button is highlighted.
  20. Click Save theme.
    The Save theme button is highlighted.
  21. Click Apply theme to add the new theme setting.

Related articles

Contact Support