API Programmer's Guide |
Version 1.13.0 (for Bomgar 15.1.x)
Front-end integration of the Bomgar API enables customers to correlate Bomgar support sessions with third-party or in-house developed applications to pull report data, issue commands, or automatically save a backup of the Bomgar Appliance's software configuration on a recurring basis.
One common example of API integration would be linking a help desk ticketing system to Bomgar sessions to track issue resolution.
You could also add a feature to an application to enable the representative to generate a session from directly within that program instead of the Bomgar representative console.
To use the Bomgar API, ensure that the Enable XML API option is checked on the Management > API Configuration page of the /login administrative interface.
For the examples in the following pages, a sample URL of support.example.com is used. Please replace this URL with your Bomgar Appliance’s public site URL.
Starting with Bomgar 14.1, the command and reporting APIs return XML responses that declare a namespace. If you are parsing these responses with a namespace-aware parser, you will need to set the namespace appropriately or ignore the namespace while parsing the XML.
- Reporting API: https://www.bomgar.com/namespaces/API/reporting
- Command API: https://www.bomgar.com/namespaces/API/command
Note: The above namespaces are returned XML data and are not functional URLs.
If you started using the API prior to 14.1, this change could break backward compatibility with current integrations if namespaces are not handled properly. If possible, test your code on a site running Bomgar 14.1.1 or up before upgrading.