Integration Lab

Documentation · Integration Guides

Set Up LTI 1.3 Between Integration Studio and API Exams

Configure Platform, Tool, Resource Link Launch, AGS and return-to-platform.

Verified
Purpose
Configure Platform, Tool, Resource Link Launch, AGS and return-to-platform.
Prerequisites
  • Administrator access to both applications
  • Server-side secret storage
Architecture
Integration Studio represents the external client or LMS. API Exams App represents the assessment provider. Exam Player is the candidate-facing browser application.

Configuration

Platform identifiersissuer, clientId and deploymentId are registration values and must agree
Tool endpoints/lti/oidc/login · /lti/launch · /.well-known/jwks
Private keyProtected API Exams .data/lti-tool-private.pem; never paste into a UI

Implementation steps

  1. 01Who is who: Integration Studio is the LTI Platform; API Exams App is the LTI Tool.
  2. 02In API Exams → Integration Clients → LTI Platform Registration enter platformName, issuer, clientId, deploymentId, authorizationUrl, tokenUrl, jwksUrl, agsUrl, nrpsUrl and deepLinkReturnUrl.
  3. 03Use the same issuer, client ID and deployment ID in Studio’s LTI Platform registration.
  4. 04Configure Tool OIDC initiation as API Exams /lti/oidc/login, Tool launch as /lti/launch, and Tool JWKS as /.well-known/jwks.
  5. 05Open Studio LTI Lab, select a resource and start Resource Link Launch.
  6. 06API Exams validates signature, issuer, audience, deployment, state and nonce.
  7. 07Complete the exam. API Exams posts the AGS score to the registered line item, then Studio Gradebook displays it.
  8. 08Use return-to-platform and verify the platform page receives the return.

Testing procedure

  • Resource Link Launch reaches Exam Player
  • AGS score appears in Gradebook
  • Return-to-platform works

Troubleshooting

LTI validation failed

Check issuer, client ID, deployment ID, URLs, JWKS, state, nonce and public base URLs.

Exam Player 404

Serve SPA fallback for /exam/session/* and /exam/login/*.