Consumers Endpoints

The Data API's consumer endpoint allows you to manage consumer configuration.

Usage

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

https://data.learnosity.com/[LTS VERSION]/consumer/keys/lti

For example, to use the 2023.1.LTS version and the 'Create LTI Key' consumer endpoint, you would create a request like so:

https://data.learnosity.com/v2023.1.LTS/consumer/keys/lti

Endpoint /consumer/keys/lti
HTTP Method POST
Action Type set
Parameter Description
label
string

A location to describe the nature or user of the LTI Key. This should be unique within the set of keys defined.

Label can be up to 255 characters long.
key
string

(Optional) A secure unique string for your LTI key.
By default, Learnosity will generate a key for you.
Note: a secret must be set if you are using this option.


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

secret
string

(Optional) A secure unique string for your LTI secret.
By default, Learnosity will generate a secret for you.
Note: a key must be set if you are using this option.


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

Example

{
    "label": "Test key for use in Learnosity quality assurance environment and documentation."
}

        /* Example Response:
        {
            "meta": {
            "status": true,
            "timestamp": 1515549097
            },
            "data": {
                "key": "DsgiVBiy3OUAzI9l",
                "secret": "05bCkbHi3OVXa10nuhWisIOwhs6hB9SC84Pyfghj",
                "label": "Test key for use in Learnosity quality assurance environment and documentation."
            }
        }
        */