Diagnostic Web Server APIs
These APIs allow you to connect to individual BrightSign players. They are especially useful if there are many players on the network so you can more quickly find and access players.
Local DWS APIs
Local access (i.e., access over the local network) of the Diagnostic Web Server (DWS) is disabled by default as of BrightSignOS 9.0.218 (on the 9.0 branch) and BrightSignOS 9.1.75 (on the 9.1 branch). In BrightSignOS versions prior to these, local access to the DWS was enabled by default. To enable local access to the DWS, see DWS: Local AccessDWS: Local Access.
Note that some specially configured players have the external microSD card port and USB storage disabled at the factory (SKU: SVC-internal-storage-only). For these players, local access to the DWS remains enabled by default.
Remote access (i.e., access over the internet) of the DWS remains available for all internet-connected players registered with BrightSign Cloud.
Local DWS APIsLocal DWS APIs let you access your players on a local network. These APIs give you information about the player, let you reboot the player, see the health of SD card, and access all of the functionality of the calls that underlie the DWS in the BrightSign Author UI. The local DWS APIs include Presentation Autorun Server APIs, which are hosted by the presentation autorun, and can be accessed with authentication from the local DWS. Only BrightScript objects in the presentation autorun know how to respond to these requests. Local DWS APIs are local player APIs and are authenticated through a username and password, not an OAuth bearer token.
Remote DWS APIs
The Remote DWS APIsRemote DWS APIs are contained in the WebSockets APIs, which use the WebSocket connection to leverage legacy endpoints that would otherwise only be addressable via the local network. Once a connection is established, the BrightSign WebSockets server can send 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. The Remote DWS APIs allow you to access your player through BSN.Cloud (using the bearer token for bsn.cloud) as well as get information about the player, reboot the player, see the health of SD card, and access all of the functionality of the calls that underlie the DWS in the BrightSign Author UI.
