Cloud API
What is Cloud API
The Cloud API manages the display via a dedicated server. Enables remote initial setup, monitoring, and control. Pre-defined settings and custom applications can be applied automatically. You can manage multiple displays either individually or in groups. Registration is required to use it.
Features
APIs Enabling Flexible Integration
Provides Provisioning API and Control & Monitoring API via the cloud. Secure access through API Key authentication enables integration with third-party systems and the development of custom solutions.
Cloud based Management
Enables remote screenshot capture and application updates. Perform troubleshooting and maintenance without on-site visits, improving operational efficiency.
Zero Touch Provisioning
After connecting the display to power and Ethernet, simply scanning a 2D barcode automatically applies settings, configures the environments, and installs apps, enabling rapid implementation.
Overview
A dedicated server hosts the Provisioning API and the Control & Monitoring API. Access to each of them requires a unique API Key, which is provided during implementation.
Provisioning API
- Used for display registration and configuration, and application installation.
- “Register a device” generates a Device ID that identifies the display.
Control & Monitoring API
- Enables monitoring and control of displays through screenshots, application updates, and more.
Access Keys for managing multiple displays in groups are generated using the Control & Monitoring API. This enables group-based control of displays.
How to Use Cloud API
How to Use Cloud API
Provides an overview of basic API specifications and communication flows, including authentication levels, control configuration, and communication notes. Understanding the overall structure helps with implementation and operational design.
Provisioning API
You can check endpoints, authentication methods, detailed request/response specifications, and error handling in a list format.
Control &
Monitoring API
You can check endpoints, authentication methods, detailed request/response specifications, and error handling in a list format.
Supported Models
The Cloud API is available for the following models:
| Supported Models | BZ40P, BZ35P, BZ30P BZ53L, BZ50L, BZ40L, BZ35L, BZ30L BZ40J, BZ35J, BZ30J BZ40H |
|---|---|
| Firmware PKG Version | 6.7283 or later |