These endpoints allow users to automatically provision BrightSign players over the internet.
Base URL for these endpoints: https://provision.bsn.cloud/rest-setup/v2
GET /setup/
Retrieves a player setup from the B-Deploy server.
URL Parameters
username
string: The username of the player setups to retrieve._id
string: The unique identifier of the player setup to retrieve. If this parameter is not included in the URL, the GET request will return all player setups associated with the username.
___________________________________________________
Request Example
username
is set toJaneDoe@brightsign.biz
_id
is set to12345
GET /rest-setup/v2/setup/?username=JaneDoe@brightsign.biz&_id=12345 HTTP/1.1 Host: provision.bsn.cloud Content-Type: application/json Authorization: {{Bearer Token}}
___________________________________________________
Success Response Body
200: Contains a single player setup if the _id
is specified in the URL; otherwise, this property contains the following:
total
int: The total number of player setups that belong to the B-Deploy accountmatched
int: The number of player setups contained in the responsedeviceSetups
deviceSetup[ ]: The Device Setup Entity (v2)
Failure Response
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method.
5XX: Any 500 code is an internal server error
POST /setup/
Adds a new player setup to the B-Deploy server.
Request Body
The following list includes only required properties for player setup creation.
version
string: The B-Deploy Cloud version. This value should currently be "2.0.0".setupType
string: The player setup type: "bsn", "lfn", "sfn", "standalone", or “partnerApplication”bsnGroupName
string: The name of the BSN.cloud group to which provisioned players will be assigned. This value defaults to the "Default" group if undefined.url
string: An optional value of the Partner Application URL specified for a player to use when finding the application to download.remoteDwsEnabled
bool: A flag indicating whether the Remote DWS is enabled or disabled on the playerbDeploy
bDeploy{ }: A B-Deploy Entity (v2)bsnDeviceRegistrationTokenEntity
tokenEntity{ }: The registration token that is used to register the player with a BSN.cloud network (see Token Entity (v2)). See this page for information about how to get a user access token.
___________________________________________________
Success Response
200: The unique identifier of the player setup object
Failure Response
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
415: The server cannot accept the data representation that you sent (as specified in the header)
5XX: Any 500 code is an internal server error
PUT /setup/
Updates an existing player setup on the B-Deploy server. You must include the _id
property in the player setup object to specify the player setup to update.
Request Body
_id
string: The unique identifier of the player setup object to modifyversion
string: The B-Deploy Cloud version. This value should currently be "2.0.0".setupType
string: The player setup type. This value is currently always "bsn".bsnGroupName
string: The name of the BSN.cloud group to which provisioned players will be assigned. This value defaults to the "Default" group if undefined.url
string: An optional value of the Partner Application URL specified for a player to use when finding the application to download.remoteDwsEnabled
bool: A flag indicating whether the Remote DWS is enabled or disabled on the playerbDeploy
bDeploy{ }: A B-Deploy Entity (v2)bsnDeviceRegistrationTokenEntity
tokenEntity{ }: A Token Entity (v2)
___________________________________________________
Success Response
200: The existing player setup has been updated
Failure Response
400: Either the request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
415: The server cannot accept the data representation that you sent (as specified in the header)
5XX: Any 500 code is an internal server error
DELETE /setup/
Deletes a player setup from the B-Deploy server.
URL Parameters
_id
string: The unique identifier of the player setup to delete
___________________________________________________
Success Response
200: The specified player setup has been removed
Failure Response
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
5XX: Any 500 code is an internal server error