VitalSource Courses and Enrolments Integration for Canvas

At VitalSource, we are committed to helping your institution improve student access to course materials while also reducing costs and boosting outcomes. To improve course materials access, we rely on LMS/VLE data to match students and instructors to their assigned course content. Providing your LMS/VLE data to VitalSource automates manual setup processes and offers valuable insights and functionality for your campus.

Leveraging Canvas REST APIs, this integration gives VitalSource additional data to complement the VitalSource LTI Tool for Canvas and enhance the user experience across VitalSource applications.

How to Set Up 

  1. Log in to Canvas, navigate to the Admin tab, and select the account under which the VitalSource-enabled courses are set up
  2. Click Developer Keys from the left navigation menu
  3. Click on +Developer Key and select +API Key
  4. Complete the Key Settings with the following information:
  • Enforce Scopes
    • Disabled: If you choose to leave this disabled, VitalSource will have permission to call all available Canvas API endpoints.
    • Enabled: If you would like to enforce scopes, please select the "Allow Include Parameters" option and enable the following required endpoints:
      • Accounts
        • url:GET|/api/v1/accounts/:account_id/courses
      • Courses
        • url:GET|/api/v1/courses
        • url:GET|/api/v1/courses/:id
      • Enrolment Terms
        • url:GET|/api/v1/accounts/:account_id/terms
        • url:GET|/api/v1/accounts/:account_id/terms/:id
      • Enrolments
        • url:GET|/api/v1/courses/:course_id/enrollments
      • External Tools
        • url:GET|/api/v1/courses/:course_id/external_tools
        • url:POST|/api/v1/courses/:course_id/external_tools
        • url:PUT|/api/v1/courses/:course_id/external_tools/:external_tool_id
        • url:DELETE|/api/v1/courses/:course_id/external_tools/:external_tool_id
      • Modules
        • url:GET|/api/v1/courses/:course_id/modules
        • url:GET|/api/v1/courses/:course_id/modules/:id
        • url:POST|/api/v1/courses/:course_id/modules
        • url:PUT|/api/v1/courses/:course_id/modules/:id
        • url:DELETE|/api/v1/courses/:course_id/modules/:id
        • url:GET|/api/v1/courses/:course_id/modules/:module_id/items
        • url:GET|/api/v1/courses/:course_id/modules/:module_id/items/:id
        • url:POST|/api/v1/courses/:course_id/modules/:module_id/items
        • url:PUT|/api/v1/courses/:course_id/modules/:module_id/items/:id
        • url:DELETE|/api/v1/courses/:course_id/modules/:module_id/items/:id
      • Sections
        • url:GET|/api/v1/courses/:course_id/sections
        • url:GET|/api/v1/courses/:course_id/sections/:id
        • url:GET|/api/v1/sections/:id
      • Users
        • url:GET|/api/v1/accounts/:account_id/users
        • url:GET|/api/v1/users/:id
  1. Click Save Key
  2. On the Developer Keys page, locate the Key you just created and toggle the State to ON
  3. Click Show Key in the Details column, and locate the Client ID
  4. Copy/paste these values and send to your VitalSource Customer Success Manager via a secure method. We recommend creating a single-use link that you can send via email with reveal.vitalsource.com.
Was this article helpful?
0 out of 0 found this helpful