Introduction

Qualtrics LTI supports using the Eduframe API as a Data source for Embedded data fields.

In order to get started, you must set up your Canvas LTI Key with specific custom fields and supply us with an Eduframe API token.

Canvas: Adding custom fields to LTI Key

In order to make use of the Course- and User-related API endpoints of Eduframe, we must pass the Course or User's SIS ID to the endpoint.

In order to have Canvas supply us with these SIS IDs, we must ensure that two custom fields are present on the LTI Key.

To configure your LTI key accordingly, follow these steps:

1. Navigate to Canvas → Root account → Developer keys.

2. Search for your Qualtrics LTI LTI Key.

3. Click Edit this key (the pencil icon on the right-hand side).

4. Under § Additional settings → Custom fields, add the following keys exactly:

   1. canvas_user_sis_id=$Canvas.user.sisSourceId
      canvas_course_sis_id=$Canvas.course.sisSourceId

Eduframe: Creating and API token

In order to make use of the Course- and User-related API endpoints of Eduframe, you must create an API token for Qualtrics LTI to use.

This API token must have the following scopes: courses:read (for the Course endpoints) and relations:read (for the User endpoints).

To create an API token, follow these steps:

1. Navigate to Eduframe → My profile → Add access token.

2. Provide any Description and Expires at that you wish.

3. Choose the following scopes: courses:read and relations:read, according to which endpoints you intend to use.

4. Click Save.

5. Copy the API token.

Qualtrics LTI: Supplying the API token

In Qualtrics LTI, follow these steps:

1. Navigate to Institute level → Burger menu (top-right) → Eduframe Configuration.

2. Paste your API token into the API token field and hit Save.

Available data

We currently support the following endpoints, which are described in Eduframe's API documentation:

• Current course edition's catalog variant (Eduframe docs: Get all catalog variants).

  • We use the first item in the response array.

• Current course edition (Eduframe docs: Get a planned course record).

• Current user (Eduframe docs: Get an user record).