Moodle LTI 1.3 Tool Installation & API Set Up

Moodle LTI 1.3 Tool Setup and Link Placement

LMS Admin/Course Set Up

The instructions below were created using Moodle version 3.8. If you are on a different supported version, your instructions might be slightly different.

System Requirements

LTI 1.3 and LTI Advantage Services are available on Moodle version 3.8 and above.

Registering LTI 1.3 Tool

1. Navigate to Site Administration → Plugins → Activity Modules → External Tool → Manage Tools.
2. Under Manage Tools select Configure a tool manually.
3. Fill in the following data in the form:
   • Tool Settings
   • Tool name: VitalSource LTI 1.3
   • Tool URL: https://bc.vitalsource.com/materials
   • Tool description: Your bookstore may have a program name they’d like to use; otherwise, we recommend VitalSource Course Materials
   • LTI version: LTI 1.3
   • Public key: https://bc.vitalsource.com/ltia/security/jwks
   • Initiate login URL: This will be provided by a VitalSource Integration Manager
   • Redirection URI(s): https://bc.vitalsource.com/oauth2callback
   • Custom parameters: Leave blank
   • Tool configuration usage: Show in activity chooser and as a preconfigured tool
   • Default launch container: New Window
   • Check Supports Deep Linking (Content-Item Message)
   • Content Selection URL: https://bc.vitalsource.com/adopt
   • Icon URL: Leave blank
   • Secure Icon URL: Leave blank

• Services
  • IMS LTI Assignment and Grade Services: Use this service for grade sync and column management
  • IMS LTI Names and Role Provisioning: Use this setting to retrieve members' information as per privacy settings
  • Tool Settings: Do not use this service
• Privacy

  • Share launcher's name with tool: Always    

  • Share launcher's email with tool: Always

  • Accept grades from the tool: Always

• Miscellaneous

  • Organization ID: Leave blank

  • Organization URL: Leave blank

4. Click Save Changes.

5. On the Manage Tools page click the configuration icon for the VitalSource LTI 1.3 tool you just created.

6. Gather the LTI 1.3 configuration details for the tool you just created and provide them to the VitalSource team here.

Managing Link Placements

Once the LTI 1.3 External Tool is installed, links can be added in the relevant courses.

Steps for Adding a Link to a Course

1. Within a course in Moodle, turn editing on.
2. In the relevant section of your course, click Add an Activity or Resource.
3. Click External Tool, then click Add.
4. Name the new activity and choose the previously created External Tool Type from the drop-down menu.
5. All other settings will be taken from the External Tool Type defaults that were selected during tool installation.
6. Click either Save and Return to Course or Save and Display.

Using the VitalSource Content Deep Linking Interface

The next step is to set up deep linking, a powerful feature of our existing LTI tooling that significantly improves course integration. Note that deep linking doesn’t require a new installation. VitalSource’s deep linking tool functions in two major capacities:

• Allows for the creation of LTI links directly to specific locations within eBooks delivered in Bookshelf®
• Allows for the creation of LTI links directly to specific locations within courseware delivered via our Partner Integration (SSO) with many of our publishing partners

1. Within a course in Moodle, turn editing on.
2. In the relevant section of your course, select Add an Activity or Resource.
3. Click External Tool, then click Add.
4. Choose the VitalSource LTI 1.3 tool from the Preconfigured tool drop-down menu.
5. Click Select Content.
6. Select your current adoption or search for content by title, author or SKU (if available).
   Note: Inclusive Access courses will not have search capability.
7. Click the Link to Specific Page button for the content for which you want to create links.
8. Select a location and click Add Materials.
9. Click Review and Submit.
10. Click Add to Course.
11. Back in Moodle review the selection and click Save and return to course.

Now that you have the main tool and deep linking installed, you’re all set! Before sending the credentials to the Integration Manager, please confirm that both endpoints are installed. Securely share the details once everything is verified.

For API set up, we can copy the instructions from our main site: Moodle APIs for Courses and Enrollments

The only change is that the last instruction:

Email the Token to the VitalSource Integration Manager

Should be swapped for the following:

Enter your web token and Moodle site here for the VitalSource team.