API access guide
Introduction
Introduction
More interface capabilities are being continuously updated...
Supported devices
Being continuously updated...
Access procedure
Search for devices
Call the search library interface we provide to obtain all devices on the LAN.
Note: The main purpose of search is to obtain the device's SN and IP address. If both the SN and IP address are already obtained, this step can be skipped.
We employ the https protocol with a fixed port number of 16674.Once a device is found, the device information will be returned through the interface callback in the following data content format:
Response package Json example:
Note: The main purpose of search is to obtain the device's SN and IP address. If both the SN and IP address are already obtained, this step can be skipped.
We employ the https protocol with a fixed port number of 16674.
Parameter name | Data Type | Description |
---|---|---|
sn | string | Product SN |
productName | string | Product name |
width | int | Screen width in pixels |
height | int | Screen height in pixels |
rotation | int | Angle of Rotation: 0, 90, 180, 270 |
aliasName | string | Screen alias |
osVersion | string | System version |
logined | boolean | Has anyone already logged in? |
- username | string array | Users who have logged in |
tcpPort | int | tcp connection port |
ftpPort | int | ftp connection port |
syssetFtpPort | int | System settings ftp port |
syssetTcpPort | int | System settings tcp port |
terminalEntrancePortHttps | int | https request Port |
terminalEntrancePortWebSocket | int | websocket port |
key | string | Key returned by the terminal |
platform | string | System platform information |
privacy | boolean | True denotes that the terminal supports encryption mode. |
ip | string | Device ip |
Log in to the player
After a player is found, you can initiate a request to the device through the device IP and port number. However, before initiating a service request, you need to log in to the player and obtain the token information. The specific code can refer to the Demo.
Business request
After logging into the device and obtaining the token sent by the device, you can initiate a request to the device with the token information, The specific code can refer to the Demo.