The LRS API

The LRS API

Our Veracity Learning LRS has many tools and features that you can use. While you can get to these features through the user interface, you can also automate some functions of your LRS. You can do this with the LRS API.

Don’t confuse the LRS API with xAPI — the LRS API isn’t the collected student performance data. Instead, with the LRS API you can create and remove students, lessons, and other data objects in your LRS, or to launch content.

Creating an API Key

To talk to the LRS API for your LRS, you'll first need to allocate a new API Key, which you’ll place in the x-veracity-api-key header of your HTTP request. To create an API key…
  1. In the LRS, from the left menu select Management > All Management Tools.

  2. Scroll down to the Security section and click API Keys.



  3. On the Manage API Keys page for this store, click the Create a New API Key button.



  4. In the Create API Key form, enter a Key Name, select the Read and Write Permissions, and click the Create button.



  5. The LRS generates a unique value for the key, which it hides. Click the Visibility button to show the key (and header), and to show the Copy button.


You can now use the API key to automate your LRS.

Using the LRS API

We keep the API at http://yourlrs.lrs.io/api (if you are serving locally, then this changes with the name of your LRS and the server options).

When you make an HTTP request, in the x-veracity-api-key header, set the value to your API key.

In general, you can POST, GET, PUT, or DELETE to the endpoints for each data model. Issuing a GET to the top-level of the data model will let you search and page-through the results. Read the LRS API documentation for the technical details.

Notes
Hits against the LRS API count against your daily API call limit the same as hits on the xAPI do.



    • Related Articles

    • The System API

      The on-premises installation of the Enterprise version of the Veracity Learning LRS includes a system-level API for creating an LRS, adding users, and more. To open the System API Keys page, in the upper-right, click the User button (your account ...

    • LRS Management

      Veracity Learning LRS gives you many tools to manage your LRS and the data in it. These include backup and restore features, import and export features, as well as tools to update, migrate, and modify the data in the LRS. LRS Management Basics Now ...

    • Power BI Integration

      How to get LRS data into Power BI You can easily connect the Veracity LRS to Microsoft Power BI. In the LRS, save a Statement Viewer report and create an API key. In Power BI, configure and activate a data download channel with this information. In ...

    • LMS Integration

      The Veracity Learning LRS offers frictionless integration with your LMS to let teachers and students access the services of the LRS without leaving the LMS. We do this using the Learning Tools Interoperability (LTI) technical standard. LTI is a ...

    • Advanced Search and Aggregation

      Veracity exposes a few extensions to our interfaces that allow you additional options for querying and analyzing data. Advanced Search Our query builder interface lets you filter on stacks of almost any property in the official xAPI specification, ...