Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The BrightSign Network REST API exposes a large set of BSN REST API is currently in development.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, 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/ ).

Headers

Accept

All data retrieval requests should contain the "Accept" header. The server supports values of "application/json" and "application/xml". 

Note
titleNote

This REST API manual describes request/response entities using their JSON 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. The server supports values of "application/json" and "application/xml".

Authorization

All requests, except for those to the /token endpoint, must contain the "Authorization" header. See the Authentication page for more details.