BrightSign cloud APIs can be categorized as follows:

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

 (bearer) token gives users authorization to communicate with APIs and send requests to the B-Deploy or Remote DWS 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:

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.

 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. 

 use the older BrightSign network to interact with BrightSign players.

videooutput

Cloud APIs

This is our legacy cloud platform. Our latest cloud platform is BSN.Cloud which consists of the free bsn.Control and the paid bsn.Content tiers. Development of BSN has largely ceased and will eventually be deprecated and replaced with BSN.Cloud.

BrightSign_Network_BSN

BrightSign’s *legacy* app for authoring and managing players. The app's actual name is BrightAuthor but is referred to as BrightAuthor Classic to lessen confusion with BrightAuthor:connected, our latest app.

BrightAuthor_Classic

BrightSign’s latest free, all-in-one app for player setup / management, authoring, and content management.

BrightAuthorconnected

The BSN.Cloud record of a player and its Setup. The Default Setup is assigned to the player unless another Setup has been explicitly set.

Provision_Record

The process where a Setup is delivered and applied to a player by BSN.Cloud.

Provision

A set of files containing player settings (player name, description, time zone, Publishing Mode, network settings, etc.) and an autorun.brs file which instructs the player what to do upon bootup.

Setup

B-Deploy Device Endpoints (v2)

B-Deploy Setup Endpoints (v2)

B-Deploy Entity  (v2)

Device Setup Entity  (v2)

Provision Record Entity  (v2)

Token Entity  (v2)

B-Deploy Setup Entities  (v2)

Version 2.0 B-Deploy Endpoints

B-Deploy Setup Endpoints (v3)

B-Deploy Entity (v3)

Device Setup Entity  (v3)

FirmwareUpdatebyFamily Entity (v3)

Interfaces Entity (v3)

Network Entity (v3)

Token Entity (v3)

B-Deploy Setup Entities  (v3)

Version 3.0 B-Deploy Endpoints

B-Deploy/Provisioning APIs

Developers

Language Reference

Object Reference

BrightScript

Enabling BrightScript-JavaScript Objects

BSBtManager

BSCECReceiver

BSCECTransmitter

BSControlPort

BSDatagramSocket

BSDeviceInfo

BSIRReceiver

BSIRTransmitter

BSMessagePort

BSSerialPort

BSSyncManager

BSTicker

BSVideoMode

Global BrightScript-JavaScript Functions

BrightScript-JavaScript Objects

BrightScript-JavaScript Migration Guide

JavaScript Event Handling

BrightSign Asset Pool

assetfetcher

assetpool

assetpoolfiles

assetrealizer

audio

audioconfig

audiooutput

chardisplay

compositor

configurednetworks

controlport

cookiestore

decoderconfiguration

devicecustomization

deviceinfo

devicestatus

dwsconfiguration

filesysteminfile

filesysteminfo

hostconfiguration

htmlwidget

keyboard

keystore

messageport

networkconfiguration

networkdiagnostics

networkhotplug

networkstatus

openvpn

pointer

pointercalibration

registry

resolver

screenshot

securestore

serialport

serialportlist

storage

storageinfo

syncmanager

system

systemtime

tvcontroller

usbfilesystem

usbhidemulator

usbhotplug

usbpowercontrol

videoinput

videomodeconfiguration

JavaScript APIs

Player APIs (BrightScript & JavaScript)

2025 API Usage Guide

Breaking Changes & Version Updates

General Information

Main API version 2022/06

Main API version 2020/10

BSN.Cloud Main APIs

bsn.Control API Integration Guide

Postman Collections

Displaying HTML with BrightAuthor:connected

Displaying HTML with BrightAuthor

Displaying HTML without BrightAuthor

How to Efficiently Restart Applications on a Player

HTML Authoring Resources

Animations and Add-on Libraries

BrightSign Extensions

Creating HTML Pages

Debugging Webpages

Disabling Staged ES6 Features

HTML Caching

HTML Content Restrictions

HTML Storage

Renderer Versions and Support

Touchscreen Support

Using HTML Websites that Require Logins

HTML Best Practices

HTML Playback Options on Series 5 Players

HTML Video

Known Issues

Node.js

Node.js Versions

HTML Development

LDWS Advanced Endpoints

LDWS Control Endpoints

LDWS Diagnostics Endpoints

LDWS Display Control Endpoints

LDWS General Endpoints

LDWS Info Endpoints

LDWS Logs Endpoints

LDWS Registry Endpoints

LDWS Remote Snapshot Endpoint

LDWS sendCecX Endpoint

LDWS Storage Endpoints

LDWS Video Endpoints

Local DWS APIs

rDWS Control Endpoints

rDWS Diagnostics Endpoints

rDWS Display Control Endpoints

rDWS Files Endpoints

rDWS Information Endpoints

rDWS Logs Endpoints

rDWS Other Endpoints

rDWS Registry Endpoints

rDWS Remoteview Endpoints

rDWS Video Endpoints

Remote DWS APIs

Diagnostic Web Server APIs

IGMP Behavior

BrightSign Registry Keys

BrightScript Debugger

BrightSign Shell