It’s easy for remote customers to request help using the Bomgar support portal web page that’s hosted on the appliance; and with Bomgar Enterprise Edition you can host as many independently customized portal pages as you wish. But it’s also possible to start a Bomgar support session from any web page, on any web server, anywhere. All it takes is a little API call. Let me show you some of the simple API calls that can be used to start sessions. You may find these useful to incorporate on existing web pages to improve and streamline the support experience for your customers.
Before we can start playing with the API, we need to adjust security settings and privileges. Since Bomgar is always focused on secure remote support it is important to note that access to the command API and reporting API can be limited through Bomgar Group Policies. First, let’s enable the API itself. Open the /login administrative interface and navigate to Management>Security. Locate and select the “Enable XML API” checkbox. This update takes effect immediately; so there’s no “Save” button to implement the change.
Immediately below the “Enable XML API” checkbox is another API-related attribute, “Allow HTTP Access to XML API.” This attribute is disabled by default and I strongly suggest that you leave it disabled. It is a best practice to always perform API calls using secure sockets HTTPS access rather than clear text transmission via HTTP. While we won’t be sending credentials via the API calls covered in this note, it is still best to take advantage of SSL encryption.