About the Sandbox (SOAP)

Broadsign provides a sandbox domain to developers integrating with Broadsign Control API using SOAP. With the sandbox, you avoid the risk of impacting your production network while testing.

On this page, we provide details about pointing your configuration to, and registering a player on, the sandbox server.

Once you have downloaded, installed and authenticated the Broadsign Control API SOAP SDK, you must configure your installation.

While configuring the installation, you can point your integration to Broadsign's sandbox server.

Warning: The sandbox and production instances have differing resource ID#s. Expect them to change if you are connecting to production (bssopen.broadsign.com) after developing your script on the sandbox. Also, when changing servers, flush any request timestamps or client-side caches you might have.

Copy 

    /* Global configuration section of the soaplib.php file. Ensure that bss_host points to the sandbox. */
    global $sdk_root, $ca_cert, $local_cert, $bss_host, $api_root;
    $bss_host = 'https://bssopen-sandbox.broadsign.com:10803';
    $sdk_root = '/opt/broadsign/suite/sdk';
    $api_root = $sdk_root . '/api';
    $ca_cert = $sdk_root . '/certs/ca_cert.pem';
    $local_cert = '/home/jon/certs/merged_cert.pem';
    $print_requests= 1;
    $print_responses = 1;
Copy 
/* Edit the api/bsapi_merged.wsdl file and, at the bottom, change the "location" attribute. */
<service name="bsapi" >
    <port binding="tns:bsapi_binding" name="bsapi_port" >
        <soap:address location="https://bssopen-sandbox.broadsign.com:10803" />
    </port>
</service>

For more detailed information:

Registering players on the sandbox domain requires a few unique steps. You need special credentials from Broadsign Services for your sandbox domain.

To register a Player on the sandbox domain:

  1. Register the player from within the player software. See Register a Player.
  2. As Broadsign Services processes these registrations manually, be sure to notify them when you register players on the sandbox domain.
  3. Point your player to the sandbox server by making the following changes in the player's registry, depending on your OS:
    • Windows 32-bit:
      • Copy 
      HKEY_LOCAL_MACHINE\software\broadsign\OrganizationDefaults\bsp\configuration\use_branch=local 
      HKEY_LOCAL_MACHINE\software\broadsign\OrganizationDefaults\bsp\configuration\local\services\bsp.connector_adaptor_factory\host_name=bssopen-sandbox.broadsign.com

    • Windows 64-bit:

      Copy 
      HKEY_LOCAL_MACHINE\software\Wow6432Node\broadsign\OrganizationDefaults\bsp\configuration\use_branch=local 
      HKEY_LOCAL_MACHINE\software\Wow6432Node\broadsign\OrganizationDefaults\bsp\configuration\local\services\bsp.connector_adaptor_factory\host_name=bssopen-sandbox.broadsign.com

    • Ubuntu:

      Copy 
      /home/bsp/.config/BroadSign.conf

      Add the following two lines to the end of the above file:

      Copy 
      configuration\local\services\bsp.connector_adaptor_factory\host_name="bssopen-sandbox.broadsign.com" 
      configuration\use_branch=local

Once you have become familiar with Broadsign's sandbox, you could do one of the following:

  • Record Requests to File: You can record to file all requests made from Broadsign Control Administrator and Broadsign Control Player to Broadsign Server. This valuable tool helps developers debug their code and become familiar with Broadsign Control API. See Recording Requests to File (SOAP).
  • Explore Common Use Cases: We provide background information and Java samples for some common use cases. See Use Cases (SOAP).
  • Explore Broadsign Control Administrator and Broadsign Control Player: We encourage developers integrating with Broadsign Control API to explore our resources in the context of our other products. We created some video and online tutorials that provide a foundation in Broadsign Control Administrator and Broadsign Control Player. See Quick Start Tutorial and Training Videos.