BrightSign REST API Overview

Owned by BrightSign TechDocs
Last updated: Mar 01, 2024
4 min read

 

BrightSign provides many separate REST APIs which allow you to interact with your player. You can use these APIs to get information about players, reboot players, retrieve logs, and much more. These APIs can be categorized as follows:

  • Authorization APIs control access to all of the BSN.cloud or BrightSignNetwork.com resources in your network.

  • B-Deploy (Setup) APIs provide tools for managing automated deployment packages.

  • Service APIs expose the functionality of our BrightAuthor and BrightAuthor:connected content management systems and let you monitor and manage BrightSign players.

  • WebSocket APIs allow you to use WebSocket communication on BrightSign players.

  • Player APIs allow you to connect directly or indirectly to individual BrightSign players. 

Note that the diagrams below describe bsn.cloud servers and APIs, but BrightSignNetwork.com servers and APIs work in the same way.

Basic Authorization APIs

Image 1: BrightSign Authorization API communication 

An OAuth (bearer) token gives users authorization to communicate with APIs and send requests to the B-Deploy or Remote DWS APIs.

  • Use this API to get a Person OAuth2 Access/Refresh token, which returns list of networks. Then, as an authenticated user, you can send a User OAuth2 Access/Refresh token to the correct network. This allows you to access the network within the scope of what you are allowed to do. 

  • This API returns either a valid token that gives you access to any version of the bsn.cloud APIs, or a valid token that gives you access to any version of the BrightSignNetwork .com APIs.

  • The bsn.cloud and BrightSignNetwork.com base URLs are:

B-Deploy (Setup) APIs

Image 2: BrightSign B-Deploy API communication

B-Deploy APIs are available through BSN.cloud for automated deployment of players in the field. These APIs deliver the setup to players and allow creation and modification of the setup packages. They consist of Provisioning Server and Provisioning Setup Server APIs:

  • The Provisioning Server (PVS) returns an URL when given a serial number for any bsn.cloud or bsn connected device. The PVS provides only REST APIs.

  • The Provisioning Setup Server (PSS) stores and serves setup packages, presentation packages and firmware updates. The PSS provides a UI (in addition to REST APIs), which makes calls to PVS to add and retrieve serial numbers and URLs. 

Service APIs

These APIs expose the functionality of our BrightAuthor and BrightAuthor:connected content management systems using a standard set of endpoints, entities, and methods. Developers can use these APIs to build custom content management interfaces with some or all of the features that we have developed for our own content management system. These APIs can also be used for device/fleet management.

BSN.cloud APIs allow users of our cloud-based infrastructure to interact with networked BrightSign players. Partners can use the BSN.cloud APIs with or without their own servers. 

BrightSignNetwork.com APIs use the older BrightSign network to interact with BrightSign players.

WebSockets APIs

The WebSockets APIs 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. 

They include the Remote DWS APIs, which 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 BrightAuthor:connected UI.

Player APIs

These APIs allow you to connect directly or indirectly to individual BrightSign players. These APIs are especially useful if there are many devices on the network so you can more quickly find and access players.

The Local Web Server APIs are remote player APIs. The Local DWS APIs are local player APIs and are authenticated through a username and password, not an OAuth bearer token:

  • Local Web Server APIs let you access and modify user variables over a local network. 

  • Local 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 BrightAuthor:connected 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.