Summary
Currently, only PRO and SE devices are supported for docking, and XONE PLUS is currently not supported.
Docking party, data return format description
# 失败示例 Status Code: 400
{
"message": "错误原因描述...",
"result": {},
"code": -1
}
# 成功示例 Status Code: 200
{
"message": "请求成功",
"result": {},
"code": 0 /*处理成功*/
}
# 失败示例 Status Code: 401
{
"message": "token过期",
"result": {},
"code": 41005
}
Device, failure retransmission strategy
- For the
Report Upload,Image Upload Interfaceinterfaces, if the request fails, it will be uploaded twice (5 minutes after the failure) , three times (25 minutes after the failure); - After
Report upload fails(including three failed attempts), clicking on the report details page again will trigger a retransmission.
Device, request HEADERS Information
| Field | Field type | Field description | Example |
|---|---|---|---|
| Accept | String | Type of data that the client-side wants to accept | application/json |
| Content-Type | String | Data type of entity data sent by the client-side | application/json |
| Authorization | String | Authentication token value | .eyJpZCI6MT.... |
Docking party, return code
http status code description
- Interface processing succeed. The HTTP status code: 200
- Interface processing failed. The HTTP status code: 400 (Trigger partial interface retransmission)
- Token invalid/expired. The HTTP status code: 401 (Will trigger token request update)
Return code to be implemented
Return Code |
message |
http status code |
|---|---|---|
| 0 | Request successful | 200 |
| -1 | Request failed, unknown error | 400 |
| 41001 | Missing authentication parameters (generating token interface) | 401 |
| 41004 | Missing token | 401 |
| 41005 | Token invalid/expired | 401 |
Precautions for face recognition docking
To be improved