The Knowledge Anywhere Public LMS API is provided to you in order to assist you in provisioning users and connect external applications to the Knowledge Anywhere LMS. To learn more about what xAPI is, read here.
Use our version 2 of Public APIs to enjoy these benefits:
- Start using newly released endpoints, e.g. pulling up all of a learner's training records or a specific course record
- Take advantage of up-and-coming API endpoints
- Faster response time
To transition from an existing v1 call to a v2 call, all that's needed is to append the v2 end point to your main LMS domain. For example, if your LMS domain is MyTrainingCenter.KnowledgeAnywhere.com, then to fetch a user from the LMS, make the following call:
https://MyTrainingCenter.KnowledgeAnywhere.com/v2/user/{externalId}
To see the full list of end points, access the Swagger v2 spec by adding this bit to your main LMS domain: /api/swagger/index.html
Example: MyTrainingCenter.KnowledgeAnywhere.com/api/swagger/index.html
Before your organization can start making calls to our Public API, security keys will need to be generated.
Authentication - Generate API Keys
The API expects a Authorization header containing a bearer token to be sent with each request to the API. In order to properly authorize with the API, you will need to sign into your LMS Admin View and obtain your client (audience) and secret keys on your Settings > Public API Keys page.
Admin View > Settings > Public API Keys > Add Public API Key
You will need to enter two pieces of information in order to generate the API Keys.
- Site Name: Name or description of your application. Ex: company or product name.
- URL: This is the URL from where you will be making the API calls.
Once that information is create, your Client and Secret API Keys will be generated. You will need this information to get your bearer token.
Knowledge Anywhere suggests downloading and using Postman to make test API requests.
Making Requests
All requests should post to the token endpoint, click here to see an example.
See more details on how to make use our Public API for the endpoints below by viewing our Swagger Spec.
List of API calls:
- Create a User
- Update a User
- Delete a User
- Search for a User
- Get a List of Users
By using Knowledge Anywhere's Public API, you are accepting our Terms of Service.