Skip to main content

Engageli LTI Integration Configuration Values

This article will cover the various Engageli-provided configuration values partners will need to key into their LMS in order to add Engageli as a tool. Likewise, it will also cover  the LMS-provided values that need to be keyed into the Engageli platform to support the LMS.

This article is to be used as a reference document; if you are looking to set up Engageli as a tool to your LMS platform for the first time, please reach out to Support.

Engageli utilizes LTI 1.3 and supports the following LTI Advantage services:

  • Names and Role Provisioning
  • Deep Linking
  • Assignment and Grade Services

Engageli-Provided Values

The below sections will cover the Engageli-provided values that the LMS will need.

Launch URL

This is the endpoint the LMS platform sends users (and their ID Token) in order to use our tool. Engageli offers options for both "Resource Link Request" and "Deep Link Request" message types.

Resource Link Request

For your basic Resource Link Request messages, Engageli offers the below options:

  • https://PARTNER.engageli.com/api/PARTNER/lti/class/login - This is the most commonly-used endpoint; if you aren't sure what to use, use this one. This endpoint will take the user to the Live Classroom lobby of the Engageli classroom associated with the course. If there is no classroom associated with the course, Engageli will automatically create one.
  • https://PARTNER.engageli.com/api/PARTNER/lti/admin/login - This endpoint will take the user to their organization’s Admin Portal. When creating this resource in the LMS, admins will want to make sure it only appears for users who can access the Admin Portal. Unauthorized users, such as learners, will simply be presented with an error message when attempting to access the Admin Portal.
     

Deep Link Request

For Deep Link Request messages, Engageli supports the following options:

  • https://PARTNER.engageli.com/api/PARTNER/lti/selector - This endpoint will load our general selector page, where the admin adding the resource is presented with several options. The option the admin selects will determine the final value of the target link associated with the resource. Below is a sample screenshot of the selector page:

    As you can see, the selector page includes options from our Resource Link Request message type and more.
  • https://PARTNER.engageli.com/api/PARTNER/lti/selector?type=content - This endpoint will load our class content selector page, where a link to a specific class recording or module can be created. Below is an image of this screen:

    When users click the link, they'll be taken to the classroom lobby. Once they join the Playback Room, the corresponding item will automatically load.

For more information about our deeplink options, please visit Engageli Deeplink Selection Screens

JSON Web Key (JWK) Set URL

Regarding passing of public keys for the OpenID Connect workflow, Engageli utilizes a JWK set, hosted on a publicly available page. The URL of the page is formatted as follows:

https://PARTNER.engageli.com/api/PARTNER/lti/keys

OpenID Connect Login Initiation URL

The OpenID Connect endpoint that initiates the authenticated workflow into Engageli is formatted as follows:

https://PARTNER.engageli.com/api/PARTNER/lti/auth

Redirect URIs

The Engageli-related redirect URIs to add to the LMS platform will vary, depending on which links the partner plans to utilize. We recommend simply adding all links that could potentially be used, so that you do not need to revisit this setting if you decide to use other endpoints. The comprehensive list is below:

https://PARTNER.engageli.com/api/PARTNER/lti/class/login
https://PARTNER.engageli.com/api/PARTNER/lti/admin/login
https://PARTNER.engageli.com/api/PARTNER/lti/selector

LMS-Provided Values

This section will cover the LMS-provided values that the Engageli team will need in order to configure support for the LMS. Engageli requires these values before any work can be done, so the first part of the setup would be to make use of the Engageli-provided values and set up Engageli from the LMS side.

  • URL / Issuer - This is the unique URL that identifies the LMS platform. This is an OIDC-related value that is determined by the LMS. What you provide to Engageli must match exactly what the LMS will include in its payload.
  • Name - The name you want to assign to this integration. If you do not provide a value, Engageli will decide on one.
  • Client ID - When an LMS platform creates an integration configuration for Engageli (or any LTI tool), it will generate a corresponding unique Client ID value for the entry.
  • Authentication Endpoint - Also referred to as the OIDC Authorization endpoint.
  • Access Token Endpoint - The endpoint from where Engageli can request an bearer token, which we’d use to interact with the LMS' LTI Advantage services (e.g. roster sync, grade sync, etc).
  • Authentication Configuration and Key - This refers to the LMS' public keys. Engageli supports either JWK_SET or JWK_KEY.
    • If the LMS utilizes JWK_SET (JSON Web Key Set URL), then Engageli will need the URL where the public key data is located. 
    • If the LMS utilizes JWK_KEY (JSON Web Key), then Engageli will need details of the public key.

Related articles