T008 – Adding BookWidgets to an LMS as an LTI 1.3 tool

An LMS administrator registers BookWidgets as an LTI 1.3 (LTI Advantage) tool by entering the BookWidgets values below in the LMS, then sending the LMS's platform values back to BookWidgets. Field names differ per LMS; match them by meaning.

If you use one of these LMSes, follow its specific guide instead:

• T003 – Adding BookWidgets to Blackboard Learn as an LTI 1.3 Tool
• T004 – Adding BookWidgets to Moodle as an LTI 1.3 Tool
• T005 – Adding BookWidgets to Schoology as an LTI 1.3 Tool
• T006 – Adding BookWidgets to Brightspace (D2L) as an LTI 1.3 Tool
• T007 – Adding BookWidgets to Canvas as an LTI 1.3 Tool

Before you begin

• You need administrator rights in your LMS that allow registering LTI 1.3 tools.
• Your LMS must support LTI 1.3 with Deep Linking. Assignment and Grade Services (AGS) and Names and Role Provisioning Services (NRPS) are optional but strongly recommended.
• Keep the BookWidgets JWKS URL at hand (step 1 below).

Steps

1. Request the JWKS URL. Contact sales@bookwidgets.com to request a JWKS URL for your LMS instance. Provide your organization name and your LMS product.
2. Register BookWidgets in your LMS. Create a new LTI 1.3 tool and enter the values from BookWidgets data to enter in your LMS.
3. Deploy the tool. Install or deploy BookWidgets for your organization and make it available to teachers in all courses. Students do not need the tool installed; they open what teachers add.
4. Collect your platform data, and it to BookWidgets. Copy the values listed in Data to send to BookWidgets from the tool's registration page. Email the values to sales@bookwidgets.com, so they can complete the registration and confirm when the integration is ready.
5. Test the integration as described in the last section.

BookWidgets data to enter in your LMS

Enter these values when you create the LTI 1.3 tool. Leave fields your LMS asks for but that are not listed here at their default.

Tool settings

• Tool name: BookWidgets   
• LTI version: LTI 1.3 / LTI Advantage   
• Domain: www.bookwidgets.com   
• OIDC login initiation URL: https://www.bookwidgets.com/lti/login   
• Redirect URI(s): https://www.bookwidgets.com/lti/return   
• Target link URI (default launch URL): https://www.bookwidgets.com/lti/create   
• Deep Linking URL: https://www.bookwidgets.com/lti/create   
• Public key type: Keyset URL (JWKS)   
• Public JWKS URL: The URL BookWidgets sent you in step 1.
• Cookies: If asked, indicate that the tool uses cookies.

Privacy

Share the launching user's name, email address and username with the tool. BookWidgets uses them to match teachers and students to their accounts and results.

Services

Enable these LTI Advantage services:

• Deep Linking
• Assignment and Grade Services (AGS)
• Names and Role Provisioning Services (NRPS)

Placements

Add the placements your LMS supports. Where a placement has its own URL field, enter the URL shown.

• Add content to a course (Deep Linking)
  • Typical LMS name: Course materials selection, assignment selection, link selection
  • Launch URL: https://www.bookwidgets.com/lti/create  
• Course results
  • Typical LMS name: Course navigation, left navigation
  • Launch URL: https://www.bookwidgets.com/lti/results  
• BookWidgets account
  • Typical LMS name: User navigation, account navigation, global navigation, app menu
  • Launch URL: https://www.bookwidgets.com/lti/account   

Availability

Make BookWidgets available to teachers and administrators in all courses. Do not restrict it to course admins only, so every teacher can add widgets.

Data to send to BookWidgets

After registering and deploying the tool, email these values to sales@bookwidgets.com. Your LMS shows most of these values on the tool's registration, API or developer-key page; some LMSes publish the platform URLs in their documentation instead.

• Issuer
  • Also called:  Platform ID, iss  
  • Example: https://lms.example.com  
• Client ID
  • Also called: Developer key ID, application ID
  • Example: 7400000000001234  
• OIDC authentication request URL
  • Also called: Authorization endpoint, auth login URL
  • Example: https://lms.example.com/api/lti/authorize  
• Public keyset URL
  • Also called: Platform JWKS URL
  • Example: https://lms.example.com/api/lti/jwks  
• Access token URL
  • Also called: OAuth2 token endpoint
  • Example: https://lms.example.com/login/oauth2/token  
• Token audience
  • Also called: Authorization server, aud  
  • Example: Only if it differs from the access token URL

Test the integration

Once BookWidgets confirms the registration, check each part in a test course:

• As a teacher, add content to the course, choose BookWidgets, pick or create a widget and return to the LMS.
• Open the added widget as a teacher and confirm the launch works.
• Open it as a test student, submit an answer, and confirm the grade appears in the LMS gradebook.
• Open the course results and account placements and confirm they launch BookWidgets.

BookWidgets is then available to all teachers in your organization.