API Integrations

API Integrations

You can use Veracity Launch to play content from your LMS. You create a launch link in our API and then forward the learner to a location in our API. The learner experiences the content seamlessly, then returns to the callback address of your choice. You can template the callback location to include information for your LMS needs, such as score, duration, and completion status of the content.

The Veracity Launch API offers these CRUD operations:
  1. Learner — POST | GET | GET List | PUT | DELETE
  2. LRS — POST | GET | GET List | PUT | DELETE
  3. API Key — POST | GET | GET List | PUT | DELETE
  4. Client Log — GET | GET List | DELETE
  5. Launch — POST | GET | GET List | PUT | DELETE
  6. Content — POST | POST Upload | GET | GET List | PUT | DELETE
  7. Registration — POST | GET | GET List | PUT | DELETE
  8. Enrollment — POST | GET | GET List | PUT | DELETE
  9. LTI — POST
  10. Invitation — POST | GET | GET List | PUT | DELETE
  11. Delegate — POST | GET | GET List | GET Download | PUT | DELETE
  12. Unit — POST | GET | GET | GET List | DELETE
  13. Default — GET xAPI statements

Create a Launch API Key

Before you can interact with the API, you'll need to allocate an API key:
  1. In the left menu, select the ADMIN > Manage Integrations > Launch API option.

  2. On the Manage API Keys page, click the Create New API Key button.

  3. In the Create API Key page, enter a Key Name (and adjust Read/Write permission as needed).

  4. Click the Create button.

  5. In the card for the new API key, next to the hidden Key Value, click the Visibility button (eye), and then click the Copy button (share icon).
In a request, paste the key into a custom authorization header: x-veracity-api-key: <key value>. 

Test a Launch API Key (OpenAPI Viewer)
You can quickly try-out your new API key and see typical uses:
  1. On the Manage API Keys page, click the API Documentation button.



  2. This navigates to the OpenAPI Viewer web site, and copies the URL for your Launch Portal as the default API Endpoint in the Server list.

  3. On the right side of the page, across from the Server list, click the Authorize button.



  4. In the Available Authorizations pop-up, paste the Key Value you copied from the Manage API Keys page in Launch.



  5. Click the Authorize button and then the Close button.

  6. In the Learner section, click the GET learner - Get a list of all learner accordion.

  7. In the accordion, in the upper-right corner, click the Try it out button.

  8. In the Parameters form, in the Page and Limit fields, enter 0 (zero).

  9. In the Search field change the drop-down menu to Get All Records.

  10. Click the Execute button.
In the Reponses form, in the Curl code box, you’ll see the HTTP request (which shows a typical use of the API URL for your portal, and a header with your key).

In the Server Response form, in the Response Body code box, you’ll see the JSON list of all the learners in your portal!

Launch API Documentation and Demonstration

You can find a generic version of our Veracity Launch API documentation in the OpenAPI viewer at REST Wiki.

We also created a simple node.js project to illustrate how to integrate with our system — with source code — in our Veracity Launch API demo on Bitbucket.