Information regarding the HelpMaster API

The HelpMaster API is a programming interface, written in Microsoft Visual Basic.NET and is implemented as a .dll file.  The API contains a rich object model that exposes properties and methods that will allow you to perform the following operations.

• Log new jobs
• Update existing jobs
• Create new actions

Currently the API has been designed to write data into the HelpMaster database, not read from it.  This means that that the API is useful for creating and updating new jobs and actions etc.  At this stage, it is not useful for retrieving data sets, or displaying bulk information.  In order to do this, please use one or more of the views within the HelpMaster database to extract your desired information.

The HelpMaster API dll (HelpMasterProAPI.dll) is installed into the default installation folder whenever you install HelpMaster.  This file needs to be located in the same location as the other HelpMaster .dll files.

API Documentation + Sample code

The API documentation and sample code is continually evolving, and will improve over time as the API develops and we receive user feedback.  The documentation and sample code can be downloaded from here.

HelpMaster API documentation (version 10/11/12)

HelpMaster API Visual Basic .net sample code (once you load this, remember to change the database connection string)

How to use the API for your own projects

1. Create a new visual Studio project
2. Add HelpMasterProAPI.dll as a project refererence (use browse to browse to the location)
3. Review the file "HelpMaster API Reference.chm" file (downloaded from link above) for details about the object model.
4. Review the sample code project for specific ways to use the API
5. Start writing your own code!

Please send any comments or errors to support@prdsoftware.com.au

Please post any comments regarding the use of the API, feature requests, or other useability issues on this forum.