門禁管理服務
1.1 門禁智能通行記錄
模型ID | 版本 |
iotx_face_record_model | 1.6 |
屬性列表
屬性名稱 | 屬性標識符 | 數據類型 | 數據描述 |
記錄標示 | eventId | String | 記錄標示 |
創建時間 | gmtCreate | Date | 創建時間 |
上報時間 | eventTime | Date | 上報時間 |
用戶Id | userId | String | 用戶Id, |
設備ID | iotId | String | 設備ID |
用戶信息擴展信息 | userExtInfo | String | 用戶擴展信息 |
設備擴展信息 | deviceExtInfo | String | 設備擴展信息 |
通行方式 | mediaType | String | 開門方式,例如face |
抓拍圖片 | pictureUrl | String | 抓拍圖片URL |
1.2 門禁傳統通行記錄
模型ID | 版本 |
iot_entrance_event_model | 1.1 |
屬性列表
屬性名稱 | 屬性標識符 | 數據類型 | 數據描述 | 必須 |
用戶ID | identityId | String | 用戶ID | 是 |
用戶姓名 | name | String | 用戶姓名 | 是 |
事件時間 | time | Date | 事件時間 | 是 |
設備ID | iotId | String | 設備ID | 是 |
通行類型 | type | String | 通行類型 - CARD門禁卡 - PASSWORD密碼 - QRCODE二維碼 | 是 |
密碼號碼 | number | String | 密碼號碼 | 否 |
門禁卡號 | cardId | String | 門禁卡號,只有type是CARD的時候有效 | 否 |
通行方向 | direction | String | 通行方向,ENTRANCE 進,EXIT 出 | 否 |
用戶擴展信息 | userExtInfo | String | 用戶擴展信息 | 否 |
設備擴展信息 | devExtInfo | String | 設備擴展信息 | 否 |
1.3 生成二維碼
生成訪客二維碼,首先需要在用戶組中添加訪客組,并且在組內添加相應的人員信息獲取到identityId。
path | 版本 | 是否需要登錄 |
/homelink/common/qrcode/generate | 1.0.1 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
identityId | String | 是 | 申請二維碼人員的統一身份ID |
codeLength | Integer | 否 | 二維碼字符串長度默認16 |
返回結果
字段名 | 類型 | 備注 |
data | String | 二維碼內容字符串 |
1.4 二維碼權限配置
將二維碼綁定到門禁設備上,系統會根據綁定關系下發到指定設備中。
path | 版本 | 是否需要登錄 |
/entrance/paas/perm/qrcode/config | 1.0.1 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
qrCode | String | 是 | 二維碼 |
iotIds | JSONArray | 是 | 待配置權限的門禁設備iotId |
identityId | String | 是 | 申請二維碼人員的統一身份ID |
effectiveTime | String | 否 | 二維碼生效期,時間格式 yyyy-MM-dd HH:mm:ss 默認為當前時間 |
expiryTime | String | 是 | 二維碼失效期,時間格式 yyyy-MM-dd HH:mm:ss 不能超過當前時間 |
maxScanTimes | Integer | 否 | 最大刷卡次數,默認為-1不做次數限制 |
maxScanScope | String | 否 | 最大刷碼次數作用范圍,默認為每個設備獨立計數。SHARE – 共享;DEVICE – 設備 |
返回結果
字段名 | 類型 | 備注 |
data | JSON | |
code | Integer | 返回碼 |
message | String | 錯誤消息 |
iotId | String | 設備iotId |
1.5 二維碼權限刪除
將二維碼從門禁設備中刪除。
path | 版本 | 是否需要登錄 |
/entrance/paas/perm/qrcode/remove | 1.0.1 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
qrCode | String | 是 | 二維碼 |
iotIds | JSONArray | 是 | 待配置權限的門禁設備iotId |
identityId | String | 是 | 申請二維碼人員的統一身份ID |
返回結果
字段名 | 類型 | 備注 |
data | JSON | |
code | Integer | 返回碼 |
message | String | 錯誤消息 |
iotId | String | 設備iotId |
1.6 用戶權限配置
將已保存的用戶圖片下發到設備端,使設備有權限識別對應的用戶。支持從設備維度和空間維度進行下發。
path | 版本 | 是否需要登錄 |
/face/paas/permission/add | 1.0.0 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
userType | String | 是 | 默認填寫IDENTITY |
userIdList | JSONArray | 是 | 用戶ID列表 |
scopeType | String | 是 | 默認填寫IOT_ID |
scopeIdList | JSONArray | 是 | 信息下發的設備列表 |
返回結果
返回結果使用通用結果類型,不使用data域。
1.7 用戶權限刪除
將已保存的用戶圖片從設備端刪除,使設備無權限識別對應的用戶。支持從設備維度和空間維度進行刪除。
path | 版本 | 是否需要登錄 |
/face/paas/permission/delete | 1.0.0 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
userType | String | 是 | 默認填寫IDENTITY |
userIdList | JSONArray | 是 | 用戶ID列表 |
scopeType | String | 是 | 默認填寫IOT_ID |
scopeIdList | JSONArray | 是 | 信息下發的設備列表 |
返回結果
返回結果使用通用結果類型,不使用data域。
1.8 查詢用戶和設備的權限關系
根據用戶ID和用戶類型查詢圖片信息及其下發的設備列表(含下發狀態)。
path | 版本 | 是否需要登錄 |
/face/paas/permission/querybyuser | 1.0.4 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
userType | String | 是 | 默認填寫IDENTITY |
userId | String | 是 | 用戶ID |
deviceListPageNo | Integer | 否 | 分頁查詢的請求頁碼 |
deviceListPageSize | Integer | 否 | 分頁查詢的請求頁大小 |
statusList | JsonArray | 否 | 狀態列表: 詳見下發狀態定義 |
下發狀態定義
狀態 | 定義 |
toBeTransferred | 等待下發 |
transferring | 下發中 |
deviceOffline | 設備離線或者設備異常 |
transferred | 下發完成 |
faceCheckTimeout | 下發失敗,提取特征值超時 |
faceDlError | 下發失敗,下載圖片失敗 |
faceCheckError | 下發失敗,提取特征值失敗或其他未知原因 |
facePushError | 下發失敗,推送到終端設備出錯 |
unknownError | 下發失敗,設備端未返回結果,原因未知 |
transferDeleted | 刪除成功 |
deleteFailed | 刪除失敗 |
transferTimeout | 下發超時 |
deleteTimeout | 刪除超時 |
返回結果使用通用結果類型,data域是對象,見下表的詳細說明:
參數 | 類型 | 備注 |
userType | String | 默認填寫IDENTITY |
userId | String | 用戶ID |
userName | String | 用戶姓名,不超過64字符 |
expiredTime | String | 圖片有效期,時間格式yyyy-MM-dd HH:mm:ss |
extInfo | String | 業務擴展字段,不超過1024字符 |
deviceListTotal | Integer | 該用戶圖片執行過下發操作的設備總數 |
deviceListPageNo | Integer | 請求頁碼 |
deviceListPageSize | Integer | 請求頁大小 |
deviceList | JSONArray | 設備列表,包含設備iotId、下發時間、下發狀態 |
iotId | String | 設備Id |
syncTime | String | 下發時間 |
status | String | 詳見下發狀態定義 |
deviceNickName | String | 設備昵稱 |
cron | String | 有效期表達式 |
1.9 根據設備查詢用戶權限
根據用戶ID和用戶類型查詢圖片信息及其下發的設備列表(含下發狀態)。
path | 版本 | 是否需要登錄 |
/face/paas/permission/querybydevice | 1.0.4 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
iotId | String | 是 | 設備iotId |
pageNo | Integer | 否 | 分頁查詢的請求頁碼 |
pageSize | Integer | 否 | 分頁查詢的請求頁大小 |
statusList | JsonArray | 否 | 狀態列表: 詳見下發狀態定義 |
返回結果
返回結果使用通用結果類型,data域是對象,見下表的詳細說明:
參數 | 類型 | 備注 |
total | Long | 下發到該設備的用戶圖片總數 |
pageNo | Integer | 請求頁碼 |
pageSize | Integer | 請求頁大小 |
data | JsonArray | 用戶列表 |
userType | String | 默認填寫IDENTITY |
userId | String | 用戶ID |
userName | String | 用戶姓名,不超過64字符 |
expiredTime | String | 圖片有效期,時間格式yyyy-MM-dd HH:mm:ss |
extInfo | String | 業務擴展字段,不超過1024字符 |
syncTime | String | 圖片下發時間 |
status | String | 下發狀態: 詳見下發狀態定義 |
cron | String | 有效期表達式 |
1.10 遠程開門服務
根據用戶ID和用戶類型查詢圖片信息及其下發的設備列表(含下發狀態)。
path | 版本 | 是否需要登錄 |
/cloud/thing/service/invoke | 1.0.1 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
iotId | String | 是 | 門禁設備的iotId |
identifier | String | 是 | 固定值“remoteOpen” |
args | JSNOObject | 是 | 固定值{} |
返回結果
返回結果使用通用結果類型,data域為空。
1.11生成加密二維碼
通過1.3生成的非加密二維碼進行RSA密鑰加密,生成88位的加密二維碼,該二維碼用于展示后給設備端掃碼使用
path | 版本 | 是否需要登錄 |
/entrance/paas/perm/qrcode/encrypt | 1.0.0 | 否 |
請求參數
參數 | 類型 | 是否必填 | 備注 |
identityId | String | 是 | 二維碼對應用戶ID |
qrCode | String | 是 | 二維碼字符串 |
expiryTime | String | 是 | 二維碼失效時間,格式: yyyy-MM-dd HH:mm:ss |
返回結果
字段名 | 類型 | 備注 |
data | String | 加密二維碼字符串 |
二維碼人員信息錄入
二維碼通行需要使用本接口將用戶信息綁定到平臺
path | 版本 | 是否需要登錄 |
/entrance/paas/user/modify | 1.0.0 | 否 |
入參
字段 | 類型 | 是否必傳 | 備注 |
identityId | String | 是 | 統一身份ID。若identityId在庫里存在走更新流程,若identityId在庫里不存在走創建流程 |
name | String | 否 | 人員稱謂。在更新的時候,如不傳不會對原有值做修改。在創建的時候必須傳。 |
extInfo | String | 否 | 自定義信息。在更新的時候,如不傳不會對原有值做修改。在創建時候可以不填。 |
出參
返回結果使用通用結果類型,data域為空。
請求示例
{
"identityId":"50acopfd3a94900494085ed2699e052432c34452",
"name":"王先生",
"extInfo":{}
}
返回示例
{
"code": 200,
"id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
"message": null,
"localizedMsg": null
}
二維碼人員刪除人員信息
path | 版本 | 是否需要登錄 |
/entrance/paas/user/delete | 1.0.0 | 否 |
入參
字段 | 類型 | 是否必傳 | 備注 |
identityId | String | 是 | 統一身份ID。 |
出參
返回結果使用通用結果類型,data域為空。
請求示例
{
"identityId":"50acopfd3a94900494085ed2699e052432c34452"
}
返回示例
{
"code": 200,
"id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
"message": null,
"localizedMsg": null
}