Black Box BDS-8W Instruction sheet

24/7 TECHNICAL SUPPORT AT 1.877.877.2269 OR VISIT BLACKBOX.COM
BDS-8W, BDS-8THA, BDS-8FHA
BDS CLOUD SERVER CONFIGURATION MANUAL
BDS CLOUD
SERVER
CONFIG

2
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877.2269
1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
TABLE OF CONTENTS
CONTENTS
1. DYNAMIC DETECTION DISPLAY CALLBACK INTERFACE V1.1 ............................................................................................................ 4
2. DYNAMIC DETECTION DISPLAY LAN INTERFACE V1.4........................................................................................................................ 6
2.1 INTERFACE SPECIFICATION.................................................................................................................................................................... 6
2.2 SET DEVICE PASSWORD .......................................................................................................................................................................... 6
2.3 PARAMETER CONFIGURATION (FACE RECOGNITION, OPENING MODE, ETC.)............................................................................. 7
2.4 GET PARAMETER CONFIGURATION (FACE RECOGNITION, SWITCHING MODE, ETC.) ................................................................ 9
2.5 PERSONNEL REGISTRATION................................................................................................................................................................. 10
2.6 PERSONNEL INFORMATION EDITING.................................................................................................................................................. 11
2.7 DELETE PERSON...................................................................................................................................................................................... 12
2.8 IDENTIFICATION RECORD ACQUISITION............................................................................................................................................ 13
2.9 MODIFY LOGO .......................................................................................................................................................................................... 14
2.10 ACQUISITION OF EQUIPMENT MAC ADDRESS ................................................................................................................................ 15
2.11 PARAMETER CONFIGURATION (BODY TEMPERATURE, MASK, FAN, ETC.)................................................................................ 15
2.12 ACCESS TO PHOTOS ............................................................................................................................................................................. 17
2.13 DEVICE PARAMETER INFORMATION ACQUISITION....................................................................................................................... 18
2.14 TAKING PICTURES................................................................................................................................................................................. 18
2.15 DEVICE INITIALIZATION....................................................................................................................................................................... 19
2.16 SYSTEM TIME SETTING ....................................................................................................................................................................... 19
2.17 IDENTIFY THE RECORDING INTERFACE CALLBACK SETTINGS................................................................................................... 20
2.18 DEVICE DOOR CONTROL ...................................................................................................................................................................... 20
2.19 GET BODY TEMPERATURE AND MASK PARAMETERS ................................................................................................................... 21
2.20 PERSONNEL CHECKUP ........................................................................................................................................................................ 22
2.21 PERSONNEL PAGE QUERY................................................................................................................................................................... 23
3. DYNAMIC DETECTION DISPLAY COMMUNICATION PROTOCOL USAGE........................................................................................ 25
3.1 PROTOCOL DESCRIPTION...................................................................................................................................................................... 25
3.1.1 INTERFACE SPECIFICATION ...........................................................................................................................................................................25
3.1.2 PROTOCOL FIELD DESCRIPTION ..................................................................................................................................................................25
3.1.3 PROTOCOL REPLY INSTRUCTIONS ..............................................................................................................................................................25
3.2 PROTOCOL LIST....................................................................................................................................................................................... 26
3.2.1 DEVICE REGISTRATION...................................................................................................................................................................................26
3.2.2 HEARTBEAT........................................................................................................................................................................................................26
3.2.3 PARAMETER CONFIGURATION.................................................................................................................................................................... 27
3.2.4 PERSONNEL REGISTRATION........................................................................................................................................................................ 29
3.2.5 PERSONNEL INFORMATION EDITING........................................................................................................................................................ 30
3.2.6 DELETE PERSONNEL........................................................................................................................................................................................31
3.2.7 IDENTIFICATION RECORD UPLOAD ADDRESS SETTING .......................................................................................................................31
3.2.8 MODIFY LOGO................................................................................................................................................................................................... 32
3.2.9 BODY TEMPERATURE AND MASK PARAMETER CONFIGURATION................................................................................................... 32
3.2.10 DEVICE INITIALIZATION............................................................................................................................................................................... 33
3.2.11 VERSION UPGRADE ....................................................................................................................................................................................... 33

3
1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877. 2 269
TABLE OF CONTENTS
3.2.12 REMOTE DOOR OPENING............................................................................................................................................................................. 34
3.2.13 REMOTE RESTART ......................................................................................................................................................................................... 34
3.2.14 TEST RESULTS OF PERSONNEL PHOTOS ............................................................................................................................................... 34
3.2.15 INQUIRY OF PERSONNEL INFORMATION................................................................................................................................................ 36
3.2.16 QUERY PERSONNEL INFORMATION RESULTS....................................................................................................................................... 36
3.2.17 QUERY PERSONNEL INFORMATION ......................................................................................................................................................... 37
3.2.18 PAGINATION QUERY RESULTS OF PERSONNEL INFORMATION....................................................................................................... 38
3.2.19 PARAMETER CONFIGURATION QUERY.................................................................................................................................................... 39
3.2.20 PARAMETER CONFIGURATION QUERY RESULTS ................................................................................................................................ 39
3.2.21 BODY TEMPERATURE PARAMETER CONFIGURATION QUERY ........................................................................................................ 40
3.2.22 QUERY RESULTS OF BODY TEMPERATURE PARAMETER CONFIGURATION................................................................................ 40
3.2.23 SHUTDOWN..................................................................................................................................................................................................... 40
3.2.24 APPLICATION GUARD....................................................................................................................................................................................41
3.2.25 POWER ON ........................................................................................................................................................................................................41
DISCLAIMER.................................................................................................................................................................................... 42
TRADEMARKS USED IN THIS MANUAL........................................................................................................................................ 42

41. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877. 2 269
CHAPTER 1: DYNAMIC DETECTION DISP. CALLBACK INT. V1.1
1. DYNAMIC DETECTION DISPLAY CALLBACK INTERFACE V1.1
Instructions: This interface is a description of the interface that the client APP pushes to other backgrounds. We recommend that you
first use postman and other tools to test and verify.
After the interface development is completed, you can set it in the APP application settings, then enter the callback address to save and
use.
INTERFACE SPECIFICATION
Interface uploadMipsGateRecord
address url address
mode POST
required parameter JSON
return type JSON
FACE DETECTION RESULT DATA PUSH INTERFACE
REQUIRED PARAMETER PARAMETER PARAMETER MODE REQUEST OR NOT EXPLANATION
device ID mac string YMAC address format, 12 bits
userId userId string YPerson ID, -1 means stranger
checkTime checkTime long Y Timestamp
name name string N Personnel name
type type int N
Identity type, 1 is visitor, 2 is
blacklist, 3 for employees, 4 for ID
card identification

5
1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877. 2 269
CHAPTER 1: DYNAMIC DETECTION DISP. CALLBACK INT. V1.1
FACE DETECTION RESULT DATA PUSH INTERFACE (CONTINUED)
REQUIRED PARAMETER PARAMETER PARAMETER MODE REQUEST OR NOT EXPLANATION
cardNo cardNo string NCard number information, stranger is empty
idCardNo idCardNo string NID card number
temperature temperature string N temperature, e.g., 36.5
mask mask int N mask, 1-wear, 0-no wear
Pic infos checkPic string NSnap pictures, the picture format is Base64
extra extra string NExtra information, extended use
ID card information sex String N
ID CARD INFO nation String N
ID CARD INFO: birthdate birthdate String N
ID CARD INFO: address address String N
ID CARD INFO: photo cardPhoto String NFrom base64
RETURN VALUE
REQUIRED PARAMETER PARAMETER EXPLANATION
Return result code 0-success, 1-fail
Return information msg Return information
Example:
{
“mac”: “8CFCA0039257”,
“userId”: “”,
“checkTime”: 1585361367292,
“name”: “test”,
“type”: -1,
“cardNo”: “”,
“idCardNo”: “440...”,
“temperature”: “36.6”,
“mask”: -1,
“checkPic”: “”,
“extra”: “”,
“sex”: “”,
“nation”: “”,
“birthdate”: “1986-9-2”,
“address”: “...”,
“cardPhoto”: “”
}return example
{
“code”: 0,
“msg”: “Push successfully”
}

61. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877. 2 269
CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4
2. DYNAMIC DETECTION DISPLAY LAN INTERFACE V1.4
2.1 INTERFACE SPECIFICATION
Interface root address: http://device ip address: 8080/
Interface form: provide external services through HTTP requests
Interface security: The device password (pass) needs to be set first when calling.
The interface for the first time, and the device password (pass) needs to be passed in as the interface security verification key for any
subsequent calls to the interface.
Interface returns
Interface general return instructions:
public class ResultInfo <T> {
private Int result; // Indicates whether the interface is tuned up, 1: succeeds, 0: fails, usually as long as the device server can respond, the
value is 1
private Boolean success; // Whether the operation is successful, the success is true, the failure is false private T data; // The business
data returned by the interface, the type can be numeric, string or collection, etc
Interface list
2.2 SET DEVICE PASSWORD
Request method: POST request
Request address: http://device IP:8080/setPassWord
DATE
FIELD DATE REQUEST DESCRIPTION
oldPass ID String YOld password
newPass String YNew password
Request description: For new devices or devices after resetting (restoring initialization), you need to set the initial password before calling
other interfaces. OldPass and newPass can be passed the same value. When changing the password, paste in the new and old password
separately.
Example:
{
“data”: “passWord:q”, // The device password, also called the interface calling password, please enter it properly. If you forget your
password, you need to reset the device, and the device will erase all data.
“result”: 1,// Interface tuning
“success”: true// Device password set successfully
}

7
1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877. 2 269
CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4
2.3 PARAMETER CONFIGURATION (FACE RECOGNITION, OPENING MODE, ETC.)
Request method: POST request
Request address: http://device IP: 8080/setConfig
DATE
FIELD MODE REQUEST DESCRIPTION
pass String YPassword setting
config Json YParameter configuration Json The following are the parameters of json
Request description
POST request parameters are placed in the body
The config request parameter is in json format, an example follows (adjust according to the actual situation).
{
“companyName”: “smdt”,
“deviceId”: 86,
“displayCustom”: “{name}”,
“displayMode”: 1,
“id”: 1,
“liveIdentiLevel”: 1,
“passType”: false,
“password”: “123456”,
“recoDistance”: “1.5”,
“recoInterval”: “2000”,
“relayDelay”: 5,
“relayMode”: 0,
“serialCustomize”: “#{idcardNum}#”,
“serialMode”: 2,
“similarity”: 80,
“strangerVoiceCustom”: “moshengren”,
“strangerVoiceMode”: 2,
“voiceCustom”: “name”,
“voiceMode”: 1,
“wg”: 0
}

81. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877. 2 269
CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4
FIELD
FIELD MODE DESCRIPTION
companyName String companyName
deviceId int deviceId
displayCustom String displayCustom default as {name}
displayMode int displayMode, 1: name, 100: custom
id int
liveIdentiLevel int Living body recognition level, default fast mode, 0 no living body, 1 fast mode cannot reject photos, 2
can reject some photos, 3 can reject photos and adapt
passType boolean Access type false into true out
password String passcode
recoDistance String Recognition distance (0.5–3)
recoInterval String Recognition interval 2000–10000
relayDelay Int Relay automatically closes after a delay of x seconds (5–63)
Relay mode Int
relayMode
0: indicates the automatic closing mode, that is, X seconds will be delayed after the relay is opened.
Dynamic closure
1: It means that it does not close automatically, that is, it will not close automatically after opening the
relay.
Fit
serialCustomize String Serial port definition, default is “#{idcardNum}#”, Unlimited length
similarity Int Similarity, default 80, 30–100 adjustment
strangerVoiceCustom String Stranger voice customization, default for stranger recognition, within 32 characters
strangerVoiceMode Int Stranger voice mode, the default stranger alarm, 1 does not require voice broadcast, 2 Stranger
alarm, 100 custom
voiceCustom String Voice customization, default is “name”, within 32 characters
voiceMode Int Voice mode, 1 no broadcast, 2 broadcast name, 100 custom
wg Int Wiegand 26 or 34 output mode, 0: output card number WG26, 1: output person
Staff ID WG26,2: output card number WG34, 3: output staff ID WG34
icNO int IC Card,
1: Card Swipe
idCardNo int ID Card
1: Close
tricolorLamp int Red light, 1: Off, 2: On

9
1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877. 2 269
CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4
Return data
{
“data”: { // Set parameters
“companyName”: “smdt”,
“deviceId”: 86,
“displayCustom”: “{name}”,
“displayMode”: 1,
“id”: 1,
“liveIdentiLevel”: 1,
“passType”: false,
“password”: “123456”,
“recoDistance”: “1.5”,
“recoInterval”: “2000”,
“relayDelay”: 5,
“relayMode”: 0,
“serialCustomize”: “#{idcardNum}#”,
“serialMode”: 2,
“similarity”: 80,
“strangerVoiceCustom”: “moshengren”,
“strangerVoiceMode”: 2,
“voiceCustom”: “name”,
“voiceMode”: 1,
“wg”: 0
},
“result”: 1, // Interface access
“success”: true // Setting successful
}
2.4 GET PARAMETER CONFIGURATION (FACE RECOGNITION, SWITCHING MODE, ETC.)
Request method: POST request
Request address: http://device IP:8080/getConfig
REQUEST DATE
FIELD MODE REQUEST DESCRIPTION
pass String YDevice password

10 1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM
NEED HELP?
LEAVE THE TECH TO US
LIVE 24/7
TECHNICAL
SUPPORT
1.877.877. 2 269
CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4
Return Example:
{
“data”: { // Set parameters
“companyName”: “smdt”,
“deviceId”: 86,
“displayCustom”: “{name}”,
“displayMode”: 1,
“id”: 1,
“liveIdentiLevel”: 1,
“passType”: false,
“password”: “123456”,
“recoDistance”: “1.5”,
“recoInterval”: “2000”,
“relayDelay”: 5,
“relayMode”: 0,
“serialCustomize”: “#{idcardNum}#”,
“serialMode”: 2,
“similarity”: 80,
“strangerVoiceCustom”: “moshengren”,
“strangerVoiceMode”: 2,
“voiceCustom”: “name”,
“voiceMode”: 1,
“wg”: 0
},
“result”: 1, // Interface access
“success”: true // Setting successful
}
2.5 PERSONNEL REGISTRATION
Request method: POST request
Request address: http://device ip:8080/person/create
REQUEST DATE
FIELD MODE REQUEST DESCRIPTION
pass String YDevice password
person Json YPersonnel information Json The following are the parameters of json