Broadsign Direct REST API

Broadsign Direct REST API

The Broadsign Direct REST API allows to automate and facilitate on-boarding process. It helps in providing a clear and complete picture of the Solution Project in terms of specifications with functional and non-functional requirements.

We use HTTP verbs, response codes, and authentication. All of our REST responses are in JSON. Also, we provide a sandbox (with its own URL) so you can test your integration (see About the Sandbox).

You will need a domain and a user on Broadsign Direct.

You must use the login endpoint to access the Broadsign Direct REST API. This endpoint will create a 'session' cookie used to authenticate all the subsequent calls. All the requests in the Broadsign Direct REST API will require this cookie to be passed.

Broadsign Services can provide you with a sandbox domain for you to test your integration. To get started, we recommend that you explore your REST architecture on your sandbox domain, then move your network to production.

To use the Broadsign Direct REST API:

  1. Access https://direct.broadsign.com/login with the following data:
    2. Copy 
    curl -v -d "email=user@email.com&password=Password" https://direct.broadsign.com/login

    Tip: Replace the email and password with your own.

    This creates the session cookie.

    The Broadsign Direct REST API will return the following sample header:

    Copy 
    Content-Length: 698
    Content-Type: text/html; charset=utf-8
    Date: Wed, 04 Jul 2018 15:27:10 GMT
    Server: Werkzeug/0.12.2 Python/3.6.3
    Set-Cookie: bssta=true; Path=/
    Set-Cookie: session=.eJwlzjEOwzAIQNG7MGewTcCQy0QGg9I1aaaqd2-kzl9P-h_Y84zrgO193rHA_pqwgc_RRJkaW6shXJBkmJXIWjpzn56DZkYQYtiTCzVXzh7JPBFHN_KQYDRNfUDjbsylt4EZKJKWmk7rilxTDWdOda0m5IrIsMB9xfmfESKqAt8fnuEwUw.Dh54zg.CN8ZKTWQYEcXtpBNKSJKoV4-PsY; HttpOnly; Path=/
    X-UA-Compatible: IE=edge,chrome=1

    The Broadsign Direct REST API will return the following sample body:

    Copy 
    {
      "message": "Logged In",
      "user": {
        "id": 855518,
        "creation_tm": null,
        "modification_tm": "2018-07-04 15:27:10",
        "name": "Test",
        "active": true,
        "domain_id": 4,
        "email": "user@email.com",
        "password": "encrypted_password",
        "last_login": "2018-07-04 15:27:10",
        "role_id": 4,
        "phone": null,
        "creation_user_id": null,
        "modification_user_id": null,
        "privileges": [
          "CREATE_PROPOSAL_FROM_PACKAGES",
          "EDIT_OWN_PROFILE",
          "BASIC_ACCESS",
          "CHERRY_PICK",
          "OVERBOOK",
          "PACKAGE_CREATION",
          "DISCOUNT_MAX",
          "FINAL_APPROVAL_USER",
          "USER_CREATION",
          "DOMAIN_SETTINGS",
          "BOOK_ALL_PROPOSALS",
          "SCREEN_ADMIN",
          "RATE_CARD_CREATION"
        ],
        "cart": 26
      }
    }
  2. Use the session cookie to authenticate the subsequent calls, for example:
    3. Copy 
    curl -H 'Cookie:session={{SESSION}}' https://direct.broadsign.com/api/v1/user/current_user

    Replace SESSION with the Set-Cookie: session= value that was returned in the header.

    The verb used ([POST/GET/PUT]) depends on the API called.

    The API call depends on the method that you are using.

Broadsign provides a sandbox domain to developers integrating with Broadsign Direct API. With the sandbox, you avoid the risk of impacting your production network while testing (the sandbox end point is: https://direct-sandbox.broadsign.com/).

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

Register a Broadsign Control Player on the Sandbox

The Sandbox environment is linked to the Broadsign Control sandbox environment. Testing the environment requires registering a Broadsign Control Player in the Broadsign Control environment. For more information, see Register a Player in the Broadsign Control Administrator documentation.

Broadsign Direct is feature-rich, robust and flexible. As a result, we have many endpoints through which you can call Broadsign Server. To review our endpoints, see REST Method Reference.