ON THIS PAGE
The BrightSign Network REST API exposes its functionality using a standardized architecture of REST endpoints. Developers can use these endpoints to build web applications for creating presentations and playlists, managing devices, monitoring device health, uploading files, and more.
URLs and Endpoints
The base URL for REST endpoints is https://api.brightsignnetwork.com/{version_date}/REST/. The current version is https://api.brightsignnetwork.com/2017/01/REST/.
Endpoints are appended to this base URL. Except for the /token endpoint, all BSN endpoints accept trailing slashes (e.g. /presentations/ ).
URL Parameters
Query strings that are appended to endpoint URLs (e.g. "?filter", "?sort") must be URL encoded.
Headers
Accept
All REST calls should contain the "Accept" header. All endpoints support the "application/json" and "application/xml" types–except for the /sessions/ endpoint, which uses a unique set of content types for file uploads.
Note
The BrightSign REST API documentation describes request/response entities using JSON examples and data types (integer, string, array, etc.).
ACCEPT-ENCODING
All data retrieval requests should contain the "Accept-Encoding" header. The server supports values of "gzip" and "deflate".
Content-Type
All update/create requests should contain the "Content-Type" header. All endpoints support the "application/json" and "application/xml" types–except for the /sessions/ endpoint, which uses a unique set of content types for file uploads.
Authorization
All requests, except for those to the /token endpoint, must contain the "Authorization" header. See the Authentication page for more details.