Test Scenario

To get started with this basic API integration, follow the steps below.

  1. Log into your Bomgar administrative interface and go to Management > API Configuration. Check the box to Enable XML API. If you do not have a valid SSL certificate, you may need to enable the option to Allow HTTP Access to XML API while you are testing.
  2. Create a special Bomgar user account to be used for API commands. Give this user a password that does not need to be reset, and enable all necessary permissions such as the ability to view reports, generate session keys, and participate in the general queue. For simplicity, you can make this user an administrator with all permissions enabled, though this is not required.
  3. After saving the user account, edit the account and check the box so that the password does not expire.
  4. Create a normal representative user account for yourself. Download the Bomgar representative console and log in.
  5. You now can begin testing API commands using your browser. Create the appropriate URLs by copying the samples into a text editor. Modify the parameters as needed for your environment, replacing the hostname, username, password, external key, and so forth.
  6. Paste the customized URLs into your browser to test the API commands. The appropriate XML should be returned in the browser.
  7. If you receive any errors such as Document Not Found, check that the API user has the necessary permissions. Also, make sure that a representative is logged into the site while you are testing.
  8. Conduct a support session using the programmatically generated, seven-character session key or corresponding direct download URL. Examine the external key, which is displayed in the representative console on the Summary tab of the support session. The key is also visible from the session queue.
  9. After the session completes, view the session report from the Bomgar administrative interface. You will notice that if assigned, the external key is displayed for each session.