New to APIs? Want to better understand the who, what, why and how of QuickHelp APIs? Look no further.
If you need more detailed API information, please refer to the following documents:
NOTE: All learning still occurs in QuickHelp.
- Centralize reporting for administrators
- Build custom reporting for managers
- Integrate search results for end users
- Centralize learning activities
- Increase user engagement
- Raise awareness
- And more...
What is an API?
What is Middleware?
Request the desired information from QuickHelp. Choose from an array of endpoints.
Determine what to do with the information received from QuickHelp (send to LMS, email managers, etc.).
NOTE: Coding is required!!
Example API Endpoints
|Endpoint||Examples of how it can be used||Status|
|Get Assets||A customers middleware can use this endpoint to populate an LMS with all available learning assets. Several LMS’s require that assets exist prior to reporting user history. Some LMS’s can even use this information to create assignments and direct users to QH directly within their LMS.||Developed|
|Get User History||This endpoint can be used to satisfy two common objectives: 1) Provide end-users with a comprehensive list of their history (both inside and outside of QuickHelp), and 2) Automate the issuance of learning credit for users.||Developed|
|Get Events||Administrators can drive awareness around upcoming events using this API. This API returns a list of events, titles, descriptions, links, etc.||Developed|
|Get Skill Paths||This endpoint returns a list of all skill paths (titles, descriptions, images, links, etc.) that can be used to drive end-user awareness and direct people into QuickHelp.||Developed|
|Get User Assignment||This endpoint can be used to centralize a list of required learning for end users, and provide visibility to managers and administrators. This endpoint returns the assignment name, description, type, link, completion status, due date, etc.||Developed|
|Get Search Results||Organizations can leverage this endpoint to return search results on their LMS, local intranet, etc., and drive people into QuickHelp. Results may also be combined with other search results (e.g. knowledge bases).||Developed|
|Create User||Integrate with HR platforms to automatically create users.||Developed|
|Update User||Integrate with HR platforms to update user information and permissions/roles.||Developed|
|Get All Customer Details||A partner can use this endpoint to get all customers and high level licensing information.||Developed|
|Get Attended Events||Get a list of events and users that attended those events based on the input date parameters.||Developed|
|List Topics||Get a list of all topics in the system with the input parameters.||Developed|
|Get Skill Path Assets||Get all the assets that constitute a skill path.||In Progress|