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.
What is an API?
An API is anacronym used for Application Programming Interface. This is basically a software intermediary that allows two applications to talk to each other.
APIs work using ‘requests’ and ‘responses.’ When an API "requests" various forms of information from an application or a server, it will receive a "response". The channel that APIs use to send and receive requests is called an endpoint.
Why should I use an APIs?
The QuickHelp API can offer the following advantages:
- 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 Endpoint?
Think of an endpoint as one end of a communication channel between different software applications. When an API interacts with these various systems, where it interacts is considered the endpoint. Each endpoint is a specific location where the API can access the data that they need to carry out the request. Keep in mind that middleware may be needed to help translation the data across the API to the endpoints.
For a list of available BrainStorm endpoints Click HERE
What is Middleware?
Middleware is software that sits between an operating system and the applications running on it; essentially working as an interpretation layer. Middleware allows for the very communication needed to collect the data from these applications. Middleware can facilitate the following:
A request for desired information from QuickHelp. You can choose from an array of endpoints.
To determine what to do with the information received from QuickHelp (send to LMS, email managers, etc.).
NOTE: Coding is required to build the middleware!
How do they all work together?
The following diagram represents the movement of data from your organization's program and QuickHelp using the QuickHelp API. Note that the middleware is what is moving the request between you and the API.
1. An end user performs a search on your LMS
2. Your middleware connects to QuickHelp API's and provides the raw user query
3. QuickHelp returns a JSON response with a list of search results
4. Your middleware formats and displays results to the end user.
Examples 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.||Developed|