Related Manuals for Black Box BDS-8W
Summary of Contents for Black Box BDS-8W
- Page 1 BDS CLOUD SERVER CONFIGURATION MANUAL BDS-8W, BDS-8THA, BDS-8FHA BDS CLOUD SERVER CONFIG 24/7 TECHNICAL SUPPORT AT 1.877.877.2269 OR VISIT BLACKBOX.COM...
-
Page 2: Table Of Contents
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 TABLE OF CONTENTS TECHNICAL SUPPORT 1.877.877.2269 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.) ................ - Page 3 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 TABLE OF CONTENTS TECHNICAL SUPPORT 1.877.877.2269 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 ............................
-
Page 4: Dynamic Detection Display Callback Interface V1.1
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 TECHNICAL CHAPTER 1: DYNAMIC DETECTION DISP. CALLBACK INT. V1.1 SUPPORT 1.877.877.2269 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. - Page 5 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 1: DYNAMIC DETECTION DISP. CALLBACK INT. V1.1 TECHNICAL SUPPORT 1.877.877.2269 FACE DETECTION RESULT DATA PUSH INTERFACE (CONTINUED) REQUIRED PARAMETER PARAMETER PARAMETER MODE REQUEST OR NOT EXPLANATION cardNo cardNo string Card number information, stranger is empty idCardNo idCardNo string...
-
Page 6: Dynamic Detection Display Lan Interface V1.4
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 TECHNICAL CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 SUPPORT 1.877.877.2269 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 Š... -
Page 7: Parameter Configuration (Face Recognition, Opening Mode, Etc.)
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 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... - Page 8 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 FIELD FIELD MODE DESCRIPTION companyName String companyName deviceId deviceId displayCustom String displayCustom default as {name} displayMode displayMode, 1: name, 100: custom Living body recognition level, default fast mode, 0 no living body, 1 fast mode cannot reject photos, 2 liveIdentiLevel can reject some photos, 3 can reject photos and adapt...
-
Page 9: Get Parameter Configuration (Face Recognition, Switching Mode, Etc.)
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 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”,... -
Page 10: Personnel Registration
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 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”,... -
Page 11: Personnel Information Editing
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 Request description POST request parameters are placed in the body The base64 string of the photo, without the header, such as: data: image/jpg; base64. Staff photos only support JPG and PNG. PERSON FIELD FIELD MODE... -
Page 12: Delete Person
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 request POST request parameters are placed in the body The base64 string of the photo, without the header, such as Staff photos only support JPG and PNG PERSON PARAMETER DESCRIPTION FIELD... -
Page 13: Identification Record Acquisition
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 REQUEST DATE FIELD MODE REQUEST DESCRIPTION pass String Device password deleteId String Delete person id Return Example: “data”: “msg: Person deleted successfully “result”: 1, “success”: true 2.8 IDENTIFICATION RECORD ACQUISITION... -
Page 14: Modify Logo
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 “name”: “pdf”, “type”: 1 “temperature”: “36.5”, “mask”: 1 // Whether to wear a mask, 1: worn, 0: not worn “birthDate”: “”, “currentTime”: 1562825856546, “idCardNum”: “null”, “imageFlag”: 1,... -
Page 15: Acquisition Of Equipment Mac Address
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 Request: POST request parameters are placed in the body The base64 string of the photo, without the header, such as: data:image/jpg;base65 Staff photos only support JPG and PNG Example: “data”: “msg: logo modify successfully”,... - Page 16 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 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). “isBodyTempAlarm”: 1, “isBodyTempStart”: 1, “isHighFeverAdopt”: 0,...
-
Page 17: Access To Photos
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 Example: “data”: { “deviceId”: 88, “id”: 10, “isBodyTempAlarm”: 1, “isBodyTempStart”: 1, “isHighFeverAdopt”: 0, “isLowFeverAdopt”: 0, “isLowTempAdopt”: 0, “isStandardTempAdopt”: 1, “isWearingMask”: 0, “standardBodyTemp”: “37.3”, “isStrangerRecord”:0, “isFan”:0... -
Page 18: Device Parameter Information Acquisition
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 2.13 DEVICE PARAMETER INFORMATION ACQUISITION Request method: POST request Request address: http://device ip: 8080/getDeviceInfo Request data: /getDeviceInfo Request data: REQUEST DATA FIELD MODE REQUEST... -
Page 19: Device Initialization
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 2.15 DEVICE INITIALIZATION Request method: POST request Request address: http://device ip: 8080/initialization Request data: REQUEST DATA FIELD MODE REQUEST DESCRIPTION pass String Device password... -
Page 20: Identify The Recording Interface Callback Settings
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 Example: “data”: “2020-03-15 22:10:50”, // Device current time “result”: 1, “success”: true 2.17 IDENTIFY THE RECORDING INTERFACE CALLBACK SETTINGS Request method: POST request Request address: http://device ip: 8080/setIdentifyCallback REQUEST DATA FIELD... -
Page 21: Get Body Temperature And Mask Parameters
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 Example: “data”: “open the door success”, “result”: 1, “success”: true Device restart Request method: POST request Request address: http://device ip: 8080/restartDevice REQUEST DATA FIELD MODE... -
Page 22: Personnel Checkup
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 Return data (for example, refer to the description of temperature and mask parameter configuration for details): “data”: { “isBodyTempAlarm “:1,” isBodyTempStart “:1,”... -
Page 23: Personnel
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 Return Data: Except for the faceID field, refer to interface 4 for the detailed field description. “data”: “[ “prescription”: “2020-03-21 00:00,2030-12-13 00:00”, “age”: 0, “card”: “”, “faceID”: 57358,... - Page 24 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DYNAMIC DETECTION DISPLAY LAN INT. V1.4 TECHNICAL SUPPORT 1.877.877.2269 Return Data: Except for the faceID field, refer to interface 4 for the detailed field description. “data”: “{ “pageInfo”: { “index”: 0, “length”: 1, “size”: 1,...
-
Page 25: Dynamic Detection Display Communication Protocol Usage
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3. DYNAMIC DETECTION DISPLAY COMMUNICATION PROTOCOL USAGE 3.1 PROTOCOL DESCRIPTION 3.1.1 INTERFACE SPECIFICATION Š Use the netty framework to establish socket connections to maintain communication and long connections Š... -
Page 26: Protocol List
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2 PROTOCOL LIST 3.2.1 DEVICE REGISTRATION Method: deviceReg Method: client->server Sample Data “method”: “deviceReg”, “timestamp”: 1584518232928, “body”: { “ip”: “192.9.51.45”, “mac”: “8CFCA0036225”, “time”: 1584518232928, “version”: “1.5.0.22.0.01”... -
Page 27: Parameter Configuration
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.3 PARAMETER CONFIGURATION Method: setConfig Method: server -> client Data Description “body” request parameter is in json format, an example follows (adjust according to the actual situation) “method”: “setConfig”, “timestamp”: 1584518232928, “body”: {... - Page 28 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 FIELD DESCRIPTION FIELD TYPE DESCRIPTION companyName String Company Name deviceId Associated equipment (id) displayCustom String Display customization, the default is {name} displayMode Display mode, 1: display name, 100: custom Living body recognition level, default fast mode, 0: no living body, 1: fast mode cannot reject liveIdentiLevel photos, 2: can reject some photos, 3: can reject photos and adapt...
-
Page 29: Personnel Registration
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.4 PERSONNEL REGISTRATION Method: person/create Method: server -> client Interface Description Š Staff photos only support JPG and PNG Š Š Photo address only supports pictures stored in http protocol Š... -
Page 30: Personnel Information Editing
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.5 PERSONNEL INFORMATION EDITING Method: person/update Method: server -> client Interface Description: Staff photos only support JPG and PNG Photo address only supports pictures stored in http protocol FIELD DESCRIPTION FIELD TYPE... -
Page 31: Delete Personnel
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.6 DELETE PERSONNEL Method: person/delete Method: server -> client DATA FIELD TYPE REQUIRED DESCRIPTION deleted String Deleted person id, multiple persons are separated by (,) “method”: “person/delete”, “timestamp”: 1584518232928, “body”: {... -
Page 32: Modify Logo
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.8 MODIFY LOGO Method: changeLogo Method: server -> client DATA FIELD TYPE REQUIRED DESCRIPTION logoUrl String Logo icon download address, only supports png, jpg Change to url download, deprecate base64 Data description: Staff photos only support JPG and PNG “method”: “changeLogo”,... -
Page 33: Device Initialization
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 CONFIG FIELD DESCRIPTION FIELD TYPE DESCRIPTION 1: Turn on the body temperature alarm isBodyTempAlarm 0: Turn off body temperature alarm 1: Turn on body temperature detection isBodyTempStart 0: Turn off body temperature detection Body temperature threshold 37.3 (accurate to one decimal place), after opening the body... -
Page 34: Remote Door Opening
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 “method”: “updateApp”, “timestamp”: 1584518232928, “body”: { “apkUrl”: “”, “md5”: “” 3.2.12 REMOTE DOOR OPENING Method: remoteOpendoor Method: server -> client 3.2.13 REMOTE RESTART Method: reboot Method: server ->... - Page 35 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 PICTURE VERIFICATION FAILURE DESCRIPTION FIELD TYPE DESCRIPTION Picture verification successful Failed to get image bitmap SDK extraction feature tool anomaly The set vipId parameter is less than 0 Image conversion failed The resolution of the picture exceeds the requirement 4096 * 2688 SDK Face Detector Abnormal...
-
Page 36: Inquiry Of Personnel Information
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.15 INQUIRY OF PERSONNEL INFORMATION Method: person/find Method: server -> client DATA FIELD TYPE REQUIRED DESCRIPTION Person ID specifies that multiple persons to be queried are separated by commas. vipId String For example, “100,101,102”, the maximum number is 50. -
Page 37: Query Personnel Information
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 Example: “body”: { “mac”: “ AADDD1254HH “, //mac address “data”: [{ “age”: 40, “name”: “hyc”, “prescription”: “2020-03-21 00:00,2030-12-13 00:00”, “sex”: 1, “type”: 1, “vipID”: 1, “faceID”: 1, //If it is less than 0, it means that the picture inspection failed, and if it is greater than or equal to 0, it means success. -
Page 38: Pagination Query Results Of Personnel Information
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.18 PAGINATION QUERY RESULTS OF PERSONNEL INFORMATION Method: person/findByPage/result Method: client -> server Data description: In addition to the mac, faceID, and pageInfo fields, refer to Interface 4 for the detailed field descriptions. Return Example: “body”: { “data”: [... -
Page 39: Parameter Configuration Query
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.19 PARAMETER CONFIGURATION QUERY Method: getConfig Method: server -> client 3.2.20 PARAMETER CONFIGURATION QUERY RESULTS Method: getConfigresult Method: client -> server Return data description: In addition to the mac field, refer to the interface 3 parameter configuration for other detailed field descriptions. -
Page 40: Body Temperature Parameter Configuration Query
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.21 BODY TEMPERATURE PARAMETER CONFIGURATION QUERY Method: getTempConfig Method: server -> client 3.2.22 QUERY RESULTS OF BODY TEMPERATURE PARAMETER CONFIGURATION Method: getTempConfig/result Method: client -> server Return data description: In addition to the mac field, refer to Interface 9 Body Temperature Parameter Settings for other detailed field descriptions. -
Page 41: Application Guard
NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: COMMUNICATION PROTOCOL USAGE TECHNICAL SUPPORT 1.877.877.2269 3.2.24 APPLICATION GUARD Method: application/guardian Method: server -> client DATA FIELD TYPE REQUIRED DESCRIPTION onoff 1: on; 0: off Data description: “body”: { “onoff”:1 //1: On 0: Off “method”: “application/guardian”, “timestamp”: 1585212192898... -
Page 42: Disclaimer
DISCLAIMER Black Box Corporation shall not be liable for damages of any kind, including, but not limited to, punitive, consequential or cost of cover damages, resulting from any errors in the product information or specifications set forth in this document and Black Box Corporation may revise this document at any time without notice. - Page 43 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 NOTES TECHNICAL SUPPORT 1.877.877.2269 1.877.877.2269 BLACKBOX.COM...
- Page 44 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 TECHNICAL SUPPORT 1.877.877.2269 © COPYRIGHT 2020. BLACK BOX CORPORATION. ALL RIGHTS RESERVED. BDS-8_CLOUD_REV1.PDF.