Advanced: Use the API to Integrate BeyondTrust with Your External Site

The BeyondTrust Application Programming Interface allows your development team to utilize the BeyondTrust functionality within your own support processes and external portals. The BeyondTrust API allows you to:

  • Generate BeyondTrust sessions
  • Manage BeyondTrust sessions
  • Access BeyondTrust's reporting features
  • Back up your BeyondTrust site configuration

While the BeyondTrust API supports the different areas described above, this document only contains customer examples that utilize the BeyondTrust API to generate BeyondTrust sessions. This document does not show examples for the other three areas supported by the BeyondTrust API, and it is not intended to show you actual coding examples. For detailed API information, refer to the BeyondTrust API Programmer's Guide.

It is important to note that using the BeyondTrust API requires knowledge of API usage and programming as a prerequisite. It is each customer's responsibility to manage their specific integration needs. For information about BeyondTrust's professional integration services, see www.beyondtrust.com/services.

Session Generation

Using the API, sessions can be generated in the same three ways as with the BeyondTrust public site, previously described in this document. These methods include:

  1. Selecting a named representative
  2. Submitting a unique session key
  3. Submitting an issue submission form

Examples

 

  These sites are provided as examples only. Please do not contact these companies for assistance with your BeyondTrust solution. Instead, please visit help.bomgar.com.

An example support portal

Example Support Portal

Depicted to the right is an example of one of BeyondTrust's customers, Computer Integrated Solutions, who utilizes the BeyondTrust API. Once a CIS customer selects Live Support from the main CIS web site, the actual support page is shown. The customer can then start a session by entering a unique session key, which is supported by the BeyondTrust API.

 

Example Support Portal

Another example of a BeyondTrust customer is RetailerSoft, who utilizes the BeyondTrust API to start sessions. At this site, customers can start a session by selecting a support representative. This representative list uses the BeyondTrust API functionality of selecting a named representative.

 

Example Support Portal

In the customer example to the right, PDS Cortext Support Center uses the BeyondTrust API to start a session by selecting a named representative.

 

Example Support Portal

Depicted to the right is another example of a BeyondTrust customer, Barry Trent, who uses the BeyondTrust API to start sessions using the issue submission form.