In this article, we'll discuss the APIs available for Learn and link to the technical documentation. If you would like to use the API, raise a support ticket and request API credentials.
Please speak to your Customer Experience Manager if you would like to arrange a conversation to discuss your requirements.
This article will be updated as new API endpoints are made available.
Current API endpoint and use cases
Authentication
The Learn API Gateway supports authentication via OAuth2.
Surfacing Learning in an External Application
This set of API end-points provides the courses and lessons for an individual User to be surfaced in third-party applications such as an Employee App or Intranet, or which can be further filtered to return the following 'states':
- Mandatory courses
- Non-mandatory courses
- Completed courses
The above states should reflect what the Learn user would see on their My Courses page; when a link is clicked, it returns the User to Learn.
Learn Inbound APIs
The inbound API supports building integrations between Learn and third-party systems. This API will support the following:
- Create a course category or use an existing one
- Create a course
- Create a Lesson
- Creating or updating a learning record result
Rate limiting
The Kallidus APIs are a key component in our products and are used by many of our customers. To ensure fair usage and protect them from abuse, we apply dynamic IP address throttling. If you receive a 429 Too Many Requests response from the API, your application will need to back off and retry the request.
A basic technique to gracefully handle limiting is to watch for 429 status codes and build in a retry mechanism using an exponential back-off schedule. The following Microsoft article provides useful information about handling failures and applying retry patterns:
https://docs.microsoft.com/en-us/azure/architecture/best-practices/transient-faults
Security and penetration testing
Kallidus performs regular security and penetration testing of all its applications, including the Kallidus APIs, and endeavours to resolve any issues promptly.
By its very nature, testing activities of this kind can lead to service degradation and sometimes complete outages. To ensure a consistent level of service, Kallidus does not permit its customers to undertake any form of security or penetration testing without prior consent.
API Documentation
Get deeper learning in The Academy
The Academy is your learning hub for Kallidus products, including live events, eLearning videos, and more. If you're new to The Academy or know someone who is missing out on free learning, contact your Customer Experience Manager or the Support Team to sign up today.
Discover the latest insights, tips and industry news on the Kallidus blog.