用户管理

API列表

请求方式	API	描述
POST	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}	新增用户信息
PUT	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}	修改用户信息
DELETE	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}	删除用户信息

新增用户信息

功能描述

设备配网完成后，需要先添加用户，才能下发这个用户的人脸照片和二维码。

接口地址

POST  /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}

请求参数

请求参数	类型	参数类型	描述	是否必传
device_id	String	URI	设备id	是
person_id	String	URI	涂鸦用户id，不超过32个字符	是
id_card	String	BODY	证件id，不超过32个字符	否
phone	String	BODY	手机号，11位数字	否
begin_time	Long	BODY	有效期开始时间，13位时间戳	否
end_time	Long	BODY	有效期结束时间，13位时间戳	否 （有效期和时间规则 二选一）
doorTimeRuleList	List	BODY	时间规则	否 最多支持3条时间规则（有效期和时间规则 二选一）
name	String	BODY	用户名，不超过64个字符	是
person_floor	Integer	BODY	用户所在楼层，边缘侧联动呼梯时使用	否
secret_key	String	BODY	用户密钥, 长度32位, 建议uuid生成。app端和设备端基于同一个密钥生成动态二维码	否
refresh_time	Long	BODY	二维码刷新时间, 默认5分钟, 单位: 毫秒	否

DoorTimeRuleRequest说明

参数名	类型	说明	备注
ruleName	String	规则名称
period	String	可进入周期段	可通行时间周期, json字符串, 例如： [{“weekDay”:1,“weekTime”:[{“start”:“32400000”,“end”:“64800000”}]},{“weekDay”:2,“weekTime”:[{“start”:“68400000”,“end”:“75600000”}]}]
allowedDate	String	可进入时间段	可通行时间段, json字符串, 例如：[{“start”:“1571587200000”,“end”:“1864569600000”},{“start”:“1573022801885”,“end”:“1864569600000”}]
deniedDate	String	不可进入时间段	不可通行时间段, json字符串, 例如：[{“start”:“1571587200000”,“end”:“1864569600000”},{“start”:“1573022801885”,“end”:“1864569600000”}]

请求示例

POST  /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627
{
  "begin_time": 1582959882104,
  "end_time": 1661666512292,
  "id_card": "1237525",
  "name": "zhangsan",
  "phone": "17326067525",
  "person_floor": 5,
  "secret_key":"fa26477e064d884c2fc13120e9daa272",
  "refresh_time": 300000
}

返回信息

参数名	类型	说明
code	Integer	响应码（详情见错误码章节）
success	Boolean	本次请求是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
sn	String	指令记录id，一个指令记录id对应一个指令

返回结果示例

{
    "success": true,
    "t": 1561456817168,
    "result": {
      "sn":"1212581947449081****"
    }
}

修改用户信息

功能描述

修改用户信息。

接口地址

PUT  /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}

请求参数

请求参数	类型	参数类型	描述	是否必传
device_id	String	URI	设备id	是
person_id	String	URI	涂鸦用户id，不超过32个字符	是
id_card	String	BODY	证件id，不超过32个字符	否
phone	String	BODY	手机号，11位数字	否
begin_time	Long	BODY	有效期开始时间，13位时间戳	否
end_time	Long	BODY	有效期结束时间，13位时间戳	否 （有效期和时间规则 二选一）
doorTimeRuleList	List	BODY	时间规则	否 最多支持3条时间规则 （有效期和时间规则 二选一）
name	String	BODY	用户名，不超过64个字符	否
person_floor	Integer	BODY	用户所在楼层，边缘侧联动呼梯时使用	否
secret_key	String	BODY	用户密钥, 长度32位, 建议uuid生成。app端和设备端基于同一个密钥生成动态二维码	否
refresh_time	Long	BODY	二维码刷新时间, 不传默认5分钟, 单位: 毫秒	否

请求示例

PUT  /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627
{
  "begin_time": 1582959882104,
  "end_time": 1661666512292,
  "id_card": "1237525",
  "name": "zhangsan",
  "phone": "17326067525",
  "person_floor": 5,
  "secret_key":"fa26477e064d884c2fc13120e9daa272",
  "refresh_time": 300000
}

返回信息

参数名	类型	说明
code	Integer	响应码（详情见错误码章节）
success	Boolean	本次请求是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
sn	String	指令记录id，一个指令记录id对应一个指令集

返回结果示例

{
    "success": true,
    "t": 1561456817168,
    "result": {
      "sn":"1212581947449081****"
    }
}

删除用户信息

功能描述

删除用户信息。

接口地址

DELETE  /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}

请求参数

请求参数	类型	参数类型	描述	是否必传
device_id	String	URI	设备id	是
person_id	String	URI	涂鸦用户id	是

请求示例

DELETE  /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627

返回信息

参数名	类型	说明
code	Integer	响应码（详情见错误码章节）
success	Boolean	本次请求是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
sn	String	指令记录id，一个指令记录id对应一个指令集

返回结果示例

{
    "success": true,
    "t": 1561456817168,
    "result": {
      "sn":"1212581947449081****"
    }
}