Sample Request Using Curl

The following are sample requests to the Broadsign Air API.

Copy 
curl -X POST \
  https://air.broadsign.com/playlist/v1/generate \        
  -H 'Authorization: Bearer cbdbc369a063de6c0f458557f1456602' \        
  -d '{    
  "player_identifier": "abcd1234",    
  "screen_identifier": "1",    
  "duration": "3600s"
  }'

 

Parameter Description
HTTP Verb The API uses the HTTP POST verb to generate a playlist for the specified parameters.
URL

The hostname that Broadsign provides.

In our example, the endpoint we want to use is playlist/v1/generate. This request will generate playlists server-side on our domain. For a complete list of all resources, see Broadsign Air API Endpoints.
Authorization Broadsign accepts an HTTP authentication token that is included in the “Authorization” header of the HTTPS requests to the REST API, as defined in RFC 7235.
player_identifier Unique Broadsign Control Player identifier, expected to represent a unique venue.
screen_identifier

Uniquely identifies individual screens within a venue that are connected to the same Broadsign Control Player. It is a customer-provided opaque value.

The screen_identifier helps accurately track how many screens have confirmed playback of content, which is crucial for providing accurate proof of plays in Broadsign Air.

Tip: Using clear and consistent screen identifiers is essential for generating accurate proof of play reports in Broadsign Air.

The same screen_identifier (for example, "screen-00", "screen-01") can be used across multiple venues, that is, they can be reused throughout different player_identifiers.

This field is not mandatory but is highly recommended for precise playback tracking.

For more information, see Reporting Players POPs with Broadsign Air.
duration See generate and for more details.

Copy 
curl -X POST \
  https://air.broadsign.com/playlist/v2/generate_long \        
  -H 'Authorization: Bearer cbdbc369a063de6c0f458557f1456602' \        
  -d '{    
  "player_identifier": "abcd1234",    
  "screen_identifier": "1",    
  "date": {
    "year": 2022,
    "month": 8,
    "day": 29
   }
  }'

 

Parameter Description
HTTP Verb The API uses the HTTP POST verb to generate a playlist for the specified parameters.
URL

The hostname that Broadsign provides.

In our example, the endpoint we want to use is playlist/v2/generate_long. This request will generate playlists server-side on our domain. For a complete list of all resources, see Broadsign Air API Endpoints.
Authorization Broadsign accepts an HTTP authentication token that is included in the “Authorization” header of the HTTPS requests to the REST API, as defined in RFC 7235.
player_identifier Unique Broadsign Control Player identifier, expected to represent a unique venue.
screen_identifier Identifier for one screen within a venue.

It can be omitted. It is a customer-provided opaque value that identifies physical players in a venue attached to the same Broadsign Control Player. They can be reused throughout different player_identifiers.

For example: multiple venues could have the same screen_identifierss such as screen-00 and screen-01. These are used to properly track how many screens have confirmed playback of items so Broadsign Air can provide accurate proof of plays.
date See generate_long for more details.