Remote DWS APIs

The Remote DWS allows you to view and modify settings on a BrightSign player over the Internet. The Remote DWS API is a REST framework that allows a client application to integrate with Remote DWS functionality.

The client application makes REST calls to the BrightSign WebSockets server, which in turn sends WebSockets messages to BrightSign players. Depending on the operation, the BrightSign player may return information to the BrightSign Websockets server, which will be relayed in the server REST response to the client application.

REST URLs

The following URLs are case sensitive, and the server may return code 426 if the case is not matched exactly.

Production Remote DWS Server: https://ws.bsn.cloud/rest/v1/

Production Authentication URL: https://api.bsn.cloud/2022/06/REST/Token/

Authentication

All Remote DWS calls require a valid authentication token. The target player must belong to the same network for which the token has been granted.

Authentication is carried out using the same OAUTH endpoint as other BSN.cloud services. See https://brightsign.atlassian.net/wiki/spaces/DOC/pages/1313046529/Main+REST+HTTP+API+version+2022+06#MainRESTHTTPAPIversion2022%2F06-AuthenticationWorkflow.

Request Headers

You should include the following request headers in your request. The Content-Type header is only needed when content is being sent in POST or PUT API calls.

headers: {
	'Accept': 'application/json, application/vnd.bsn.error+json',
	'Authorization': 'Bearer {{UserAccessToken}}',
	'Content-Type': 'application/json',
}

Request Message Format

HTTP requests to Remote DWS resources must be JSON formatted and contain the following URL parameters:

destinationType string: The device type. The only currently accepted value is "player".
destinationName string: The device serial number

Requests that require a JSON body need to have an outer data object. For instance, if a route expects [bool] enabled then the full JSON body would look like:

{
  "data": {
    "enabled": false
  }
}

Some requests also require resource-specific properties in the URL or request body, as detailed in the URL Parameters and Request Body sections below.

Response Message Format

The server will respond to a REST request with a success or error message, which may also contain resource-specific properties, as detailed in the Response Body sections below.

Returned JSON objects will have an outer object containing the methods below, where data is an error or a result object containing the returned values:

route string: The route the request was sent to
method string: The request method
data object: The returned data

For example:

{
  "route": "/v1/info",
  "method": "GET",
  "data": {
    "result": {
      "model": "LS424"
      ...
    }
  }
}