Submit a request
Submit a request

Learnosity API Versioning

General overview on how we implement the API Versioning.
 

Instead of calling each API’s specific version, you call a single version, and we manage the complexity of serving up the correct version.

For example, rather than calling a discrete version number for Items APIAuthor API and Reports API respectively -- you can simply specify v2020.2.LTS for all of them, and know the versions will all work together in perfect harmony.

Note: this pattern has been in place since the 6th of June, 2018 and is the supported versioning method.

For example:

Description Example
Template for API request URL 
- YYYY: four digit year of release 
- X: incremental number identiying release in year 
- LTS: Moniker flagging long term support 
Note: Data API doesn't have a question mark (?) in the URL
https://items.learnosity.com/?vYYYY.X.LTS 

https://authorapi.learnosity.com/?vYYYY.X.LTS 

https://reports.learnosity.com/?vYYYY.X.LTS 

https://data.learnosity.com/vYYYY.X.LTS
Lock to 2020.2 Long Term Supported version of APIs https://items.learnosity.com/?v2020.2.LTS 

https://authorapi.learnosity.com/?v2020.2.LTS 

https://reports.learnosity.com/?v2020.2.LTS 

https://data.learnosity.com/v2020.2.LTS
Track the latest release available of the API Items API Release Logs 
Author API Release Logs 
Reports API Release Logs 
Data API Release Logs

For further information and frequently asked questions you can read our Easier Versioning for Learnosity APIs Blog Article.

To provide information that might be helpful when upgrading to a current Long Term Support release, the formats of legacy versioning syntax are provided below. These formats are no longer supported and will automatically be mapped to a current version of each API, described below. To maintain control over which versions you deliver, and allow testing before deployment, use the Long Term Release format above.

When looking at any occurrences of the following in your legacy codebase, the following will be true. Providing no version: https://<api_name>.learnosity.com/, or specifying a major version only: https://<api_name>.learnosity.com/?v1, will deliver the dev-only latest version of the API. This has the same effect as specifying: https://<api_name>.learnosity.com/latest. This can be useful for testing new features in a development environment only. However, we strongly recommend that you not use this format in production.

Legacy semantic versioning syntax also allowed you to specify a major.minor.patch version: https://<api_name>.learnosity.com/?vX.Y.Z . This meant that version 1.0.3 of the API would be available at https://<api_name>.learnosity.com/?v1.0.3. As of July 8, 2020, this format will remap to the most-recent LTS release (see above).

The following table summarizes the previously available formats, and their current outcome:

URL Description
https://<api_name>.learnosity.com/ Latest release available of the API. Dev-only.
https://<api_name>.learnosity.com/?vX Latest release available of the API. Dev-only.
https://<api_name>.learnosity.com/?vX.Y Most-recent LTS release.
https://<api_name>.learnosity.com/?vX.Y.Z Most-recent LTS release.

 

 

Was this article helpful?
1 out of 1 found this helpful

Did you arrive here by accident? If so, learn more about Learnosity by clicking here.