LTI
LTI (Learning Tools Interoperability) lets a learning management system (LMS) open a lab inside a course. Instruqt supports LTI 1.1 and LTI 1.3.
When a learner opens the lab from the LMS:
- The lab opens inside the LMS page. Instruqt signs the learner in with their LMS identity, so they do not need to be a member of your team.
- Each launch gives the learner access to that one lab, for one play.
- When the learner completes the lab, Instruqt sends a full grade back to the LMS.
You set up LTI once per LMS, then add each lab to the LMS with its own URL.
Before you start
Section titled “Before you start”- Your team needs LTI credentials. In the sidebar, click Settings → API keys. In the LTI credentials section, click Generate credentials if the team has none yet. The team needs an API key first. See API keys.
- You need admin access to the LMS, to add Instruqt as an external tool.
Get the lab’s LTI details
Section titled “Get the lab’s LTI details”- Open the lab.
- In the top bar, click Share → LTI integration.
The LTI configuration drawer shows the details for both LTI versions:
| Version | Field | Use it for |
|---|---|---|
| 1.1 | URL | The launch URL of this lab: https://lti.instruqt.com/<team>/labs/<lab> |
| 1.1 | Consumer Key, Consumer Secret | Your team’s LTI credentials. The LMS signs every launch with them. |
| 1.3 | Tool URL | The launch URL of this lab: https://lti.instruqt.com/v3/<team>/labs/<lab> |
| 1.3 | Login URL | The URL where the LMS starts the LTI 1.3 login. |
| 1.3 | Public Keyset URL, Public Key | Instruqt’s public key, which the LMS uses to verify Instruqt. Give the LMS one of the two. |
The URL names the team and the lab. Each lab has its own URL.
Set up LTI 1.1
Section titled “Set up LTI 1.1”- In the LMS, add Instruqt as an external tool with LTI version 1.1.
- Set the tool URL to the lab’s URL.
- Set the consumer key and the shared secret to the Consumer Key and Consumer Secret.
- To send grades back, allow the tool to return grades to the LMS.
LTI 1.1 needs no setup in Instruqt beyond the team’s LTI credentials.
Set up LTI 1.3
Section titled “Set up LTI 1.3”LTI 1.3 needs setup on both sides: the LMS must know Instruqt, and Instruqt must know the LMS.
Step 1: Add Instruqt as a tool in the LMS
Section titled “Step 1: Add Instruqt as a tool in the LMS”- In the LMS, add Instruqt as an external tool with LTI version 1.3.
- Set the tool URL to the lab’s Tool URL.
- Add the same Tool URL as a redirection URI. The LMS refuses the launch if the tool URL is not in its list of redirection URIs.
- Set the initiate login URL to the Login URL.
- Set the public key type to keyset URL, and use the Public Keyset URL. If the LMS does not support a keyset URL, paste the Public Key.
- To send grades back, enable the LMS’s assignment and grade services (AGS) for the tool.
- Save the tool. The LMS then shows the details of the tool on its side: a client ID, a deployment ID, and the LMS’s own URLs. You need them in step 2.
Step 2: Register the LMS in Instruqt
Section titled “Step 2: Register the LMS in Instruqt”- In the sidebar, click Integrations → LTI.
- Click Add new tool.
- Fill in the form with the details the LMS showed in step 1:
| Field | Value |
|---|---|
| Name | Any name. It is shown only on the LTI integrations page. |
| Client ID | The client ID the LMS created for the tool. |
| Issuer | The LMS’s platform ID, usually the base URL of the LMS. |
| Key Set URL | The LMS’s public keyset URL. |
| Public Key | The LMS’s public key. Use it only if the LMS has no keyset URL. Fill in the Key Set URL or the Public Key, not both. |
| Access Token URL | The LMS’s access token URL. |
| Auth URL | The LMS’s authentication request URL. |
| Deployment IDs | The deployment ID of the tool, as a comma-separated list if there are more. |
- Click Save.
Grades
Section titled “Grades”Instruqt sends a grade when the learner completes the lab: every chapter is completed or skipped.
- LTI 1.1: Instruqt sends a score of 1.0 through LTI Basic Outcomes.
- LTI 1.3: Instruqt sends the maximum score through the assignment and grade services. If the LMS has no grade item for the activity yet, Instruqt creates one.
A session that the learner stops, or that expires, sends no grade.
Learner details
Section titled “Learner details”The LMS decides which details about the learner it sends. Instruqt uses the name and email address only when the LMS sends them. Many LMSs keep them back by default. To send them, enable the tool’s privacy settings that share the launcher’s name and email address with the tool.
Troubleshooting
Section titled “Troubleshooting”| Problem | Cause and fix |
|---|---|
The launch shows registration not found or ambiguous | Instruqt has no LTI 1.3 registration for the client ID and deployment ID that the LMS sent. Add the tool in Integrations → LTI, as in step 2. A new tool in the LMS usually has a new client ID. |
| The LMS refuses the launch with an unregistered or invalid redirect URI | Add the lab’s Tool URL to the tool’s redirection URIs in the LMS. |
The drawer shows No LTI credentials configured for this team | The team has no LTI credentials yet. Generate them in Settings → API keys. See Before you start. |
| The learner completes the lab, but the LMS shows no grade | For LTI 1.1, allow the tool to return grades. For LTI 1.3, enable the assignment and grade services for the tool. |
