Overview
Estimated reading time: 4 minutes
Note:
The support information on this page may differ by region in terms of availability and timing.
*Japan : Support is scheduled for soon. API Specs for Provisioning is not supported. API Specs for Management is planned to be supported.
*China : Not supported
What is Cloud API
Sony’s Cloud API for BRAVIA Professional Displays is a powerful platform for rapid provisioning and ongoing device management.
Alongside remote device management, our Cloud API enables zero-touch provisioning for display installation. After connecting the display to power and ethernet, a simple QR code scan is used to automatically apply pre-set display power and AV settings, configure your device environment, and install custom applications.
This solution is designed to dramatically simplify initial setup and remote troubleshooting for all your displays, delivering peace-of-mind, cost efficiency, and dependable performance.
*1. Up to 3 preset APK applications can be installed via Zero-touch Provisioning
Who is this for?
The Cloud API for BRAVIA is available through your partnership with Sony and is compatible with a range of BZ-series Professional Displays using package version 6.7283 or later.
This solution is ideal for customers managing large display deployments that require detailed and distinct configurations. It is particularly well-suited for use in digital signage, hospitality, and corporate meeting spaces. The Cloud API provides a secure platform for provisioning and administering displays or groups of displays, enabling efficient device control and hardware monitoring.
Model | BZ-L series: BZ53L, BZ50L, BZ40L, BZ35L and BZ30L BZ-J series: BZ40J, BZ35J and BZ30J BZ-H series: BZ40H |
---|---|
Package version | 6.7283 or later version |
The BRAVIA Cloud API platform
The following diagram illustrates a simple network structure of the Cloud API. Sony’s server hosts the Provisioning API and Management API, which application partners can access via the cloud.
・The Provisioning API enables the registration of displays and configuration of default settings, among other functions.
・The Management APIs allow partners to perform actions such as taking screenshots and updating applications.
Sony provides an API key to partners for accessing these APIs. Additionally, partners can create access keys via the API to enable access control on a group-by-group basis.
Glossary
Access Key | A key used to define device groups for remote device management. It can be created by using Device Management API. Multiple Access Keys can be created, but each device can only be assigned to a single Access Key | ||||
API key | Rotating authentication key for your Cloud API instance | ||||
Device ID | Once each BRAVIA display is successfully provisioned, it is allocated a unique Device ID in the Cloud API | ||||
Group | Displays can be allocated to different groups for easy configuration and management. Each group has its own distinct Access Key, to allow for different administrators. | ||||
RDM | Sony’s proprietary Web application “Remote Device Manager”. It is out of scope of this document | ||||
Service Provider ID | The unique user ID allocated on Sony servers | ||||
User data | Supplementary information to identify the device, e.g., the name of the tenant where the device is installed, or anything you want to define. | ||||
Webhook URL | The user-defined location linked to Service Provider ID, where Token for device management will be sent in callback from Sony server when provisioning is complete. It must be HTTPS URL with an official server certificate | ||||
ZTP | Zero-touch Provisioning. Compatible models display a QR code which can be scanned to initiate automatic settings configuration, application installation, and Cloud API environment setting |