Sample Request Using Curl
The following are sample requests to the Broadsign Air API.
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 | 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 For example: multiple venues could have the same |
duration | See generate and for more details. |
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 For example: multiple venues could have the same |
date | See generate_long for more details. |