Consumers endpoint

Manage the API consumer configuration.

Endpoints:

Create LTI Key

Usage

The format of requests to the Data API uses the following syntax:

https://data.learnosity.com/{LTS_VERSION}/{endpoint}

For example, to use the v2025.2.LTS version and the /consumer/keys/lti endpoint, you would create a request like so:

https://data.learnosity.com/v2025.2.LTS/consumer/keys/lti

Important The Data API is not a REST API. All requests must use the POST method, with the action request body parameter specifying the operation to use. The Learnosity SDK must be used to make requests to Data API.

Note The Data API usage is subject to rate limits.

Getting Started with the Data API
See Release Cadence and Version Lifecycle for more information on available LTS versions.

Create LTI Key

You would want to use this endpoint to set up an integration between a Learning Management System (LMS), such as Canvas, and Learnosity. For example, see Using Grade Passback with Learnosity and an LMS Platform.

Endpoint	/{LTS_VERSION}/consumer/keys/lti
HTTP method	POST
Action type	`"set"`

Request body parameters

Body content type: application/json

key string

A secure unique string for your LTI key. By default, Learnosity will generate a key for you.

Important A secret must be set if this option is used.

Key requirements:
- Must be between 16-255 (inclusive) characters long.
- Limited to the characters: a-z 0-9 ! # % & , - _ / ^ $ * + . |
- Must not be the same as secret.
Minimum length: 16

Maximum length: 255
label string

A human-readable description of the LTI key. This value should be unique for each key.

Maximum length: 255
secret string

A secure unique string for your LTI secret. By default, Learnosity will generate a secret for you.

Important A key must be set if this option is used.

Secret requirements:
- Must be between 16-255 (inclusive) characters long.
- Limited to the characters: a-z 0-9 ! # % & , - _ / ^ $ * + . |
- Must not be the same as key.
Minimum length: 16

Maximum length: 255

Request body example

{
    "label": "Test key for use in testing environment and documentation."
}

Responses

Response example

{
    "meta": {
        "status": true,
        "timestamp": 1515549097
    },
    "data": {
        "key": "DsgiVBiy3OUAzI9l",
        "secret": "05bCkbHi3OVXa10nuhWisIOwhs6hB9SC84Pyfgh",
        "label": "Test key for use in testing environment and documentation."
    }
}