Consumers Endpoints
The Data API's consumer endpoint allows you to manage consumer configuration.
You would want to use this 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.
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.3.LTS version and the 'Create LTI Key' consumer endpoint, you would create a request like so:
https://data.learnosity.com/v2023.3.LTS/consumer/keys/lti
Create LTI Key
Endpoint | /[LTS_VERSION]/consumer/keys/lti |
---|---|
HTTP Method | POST |
Action Type | set |
Parameter | Description |
label string |
A human readable description of the LTI key. This value should be unique for each key. Maximum: 255 characters. |
key string |
(Optional) A secure unique string for your LTI key. By default, Learnosity will generate a key for you. Note: a Key requirements:
|
secret string |
(Optional) A secure unique string for your LTI secret. By default, Learnosity will generate a secret for you. Note: a Secret requirements:
|
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."
}
}
*/