LTI Tool Registration

Next, you’ll need to setup your app as an LTI tool. As per 1EdTech’s LTI1.3 standard, an LTI (Learning Tools Interoperability) Tool is a third-party learning application or service that integrates with an educational platform like StudyReel using the LTI standard. By registering as an LTI tool, your app becomes accessible within StudyReel, where it can launch in a secure and context-aware manner.

To register an LTI tool with the StudyReel platform, use the following endpoint:

HTTP Method: POST

Base Production URL: https://prod-studyreel.alpha1edtech.com/

Base Staging URL: https://studyreel.alpha1edtech.com/

Endpoint URL: /tools/register

API Endpoint

Use this endpoint to register an LTI tool with the StudyReel platform.

Headers

Name	Value
Content-Type	application/json
x-api-key	<your-api-key>

Example body payload:

{
  "name": "My Awesome Reading App",
  "description": "My reading app teaches you how to read.",
  "launchUrl": "https://myawesometool.com/launch",
  "logoUrl": "https://myawesometool.com/logo.png",
  "coverImageUrl": "https://myawesometool.com/cover.jpg",
  "status": "active",
  "platform": "1EdTech",
  "version": "1.3",
  "namesAndRolesService": "https://platform.com/lti/nrps",
  "gradeService": "https://platform.com/lti/ags",
  "redirectUris": [
    "https://myawesometool.com/auth/callback"
  ],
  "contacts": [
    {
      "name": "John Doe",
      "email": "[e-mail]"
    }
  ]
}

Name	Required	Type	Description
name		string	The name of the LTI tool i.e., your app
description		string	A brief description of your app, visible to students
launchUrl		string	The URL StudyReel should send the LTI launch request to
logoUrl		string	URL of your app’s logo
coverImageUrl		string	URL of your app’s cover image to be shown in your app page
status		string	Status of the app on StudyReel
platform		string	The platform name (e.g., "1EdTech").
version		string	Your app’s version. This can be used for rollbacks.
namesAndRolesService		string	URL of your LTI Names and Roles service
gradeService		string	URL of your LTI Grade Service
redirectUris		array of strings	Whitelisted URIs StudyReel would redirect students to. These are the only URIs StudyReel would accept as a redirection, and so your login URI should be a part of this.
contacts		array of objects	Contact information for support, including name and email.

Response

201

{
  "status": "success",
  "message": "Tool registered successfully",
  "toolId": "5be8e7a4-f6dc-4266-a5af-3c86fe108a36",
  "deploymentKey": "U3BhcnNoJ3MgdGVzdCBhcHAgNjoxLjM="
}

400

401

500