Web API Overview
The HelpMaster WebAPI provides a JSON-based RPC-style developer interface to database and key HelpMaster functions. It can be used to integrate HelpMaster with other systems and processes. The WebAPI deploys with a Swagger Interface for ease of use, testing and documentation.
Installation
The WebAPI is an ASP.NET Core application that is hosted by Microsoft IIS and is installed via the HelpMaster Web Setup Wizard.
The WebAPI gives programmatic/developmental access to the underlying database of HelpMaster for both read and write operations. The web API should be secured via SSL, and access tokens should be carefully and securely managed by the HelpMaster system administrator.
See also
Install the HelpMaster Web components
Install the WebAPI via the HelpMaster Web Setup Wizard
API Configuration + Web tokens
Swagger Website - swagger.io (External link)
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.