About the Sandbox (REST)

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

The Broadsign Control API sandbox hostname is: https://api-sandbox.broadsign.com.

We recommend using an HTTP Token to authenticate API calls to the sandbox domain. See About the HTTP Token.

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

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 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