全部产品

梯控数据同步服务API

1 版本记录

版本号

修改时间

修改内容

修订人

V1.0

2021-01-15

正式发布版

天何

V0.2

2021-01-08

增加可选参数elevatorDoor

天何

V0.1

2020-12-25

初始版本

天何

2 使用说明

  • 本文档提供的接口用于实现门禁通行事件自动触发梯控设备呼梯,为设备联动提供所需的数据。

  • 本文档提供的接口需要使用应用服务平台的项目appKey调用,否则可能会导致查询不到对应的边缘集群,数据无法正常下发。

  • 相关的门禁设备和梯控设备需要绑定到边缘集群所在的项目。

3 接口列表

梯控设备数据管理

接口名称

接口路径

当前版本

保存设备数据

/elevator/entrance/device/save

1.0.0

删除设备数据

/elevator/entrance/device/delete

1.0.0

查询设备数据

/elevator/entrance/device/query

1.0.0

梯控用户数据管理

接口名称

接口路径

当前版本

保存用户数据

/elevator/entrance/user/save

1.0.0

删除用户数据

/elevator/entrance/user/delete

1.0.0

查询用户数据

/elevator/entrance/user/query

1.0.0

4 保存设备数据

新增或更新门禁设备和梯控设备的联动关系,并指定门禁设备所在的楼层和联动呼梯的延迟执行时间。

path

版本

是否需要登录

/elevator/entrance/device/save

1.0.0

入参

入参

类型

是否必填

说明

dataId

String

代表该接口录入的联动关系的数据项id,不填则表示新增联动关系,填则表示更新(门禁和梯控设备id不允许更新)

entranceIotId

String

门禁设备id,新增联动关系时必填

entranceFloor

String

门禁设备所在楼层,新增联动关系时必填

elevatorIotId

String

梯控设备id,新增联动关系时必填

elevatorDoor

Integer

数值型的电梯门枚举值,用于多门电梯的情况,选填

0:A门

1:B门

delaySeconds

Integer

延迟执行的秒数,不填则表示立即执行

executionNode

String

执行节点,当前仅支持EDGE,即边缘执行,新增联动关系时必填

出参

出参

类型

说明

code

Integer

响应码

message

String

响应消息

data

String

数据项id

入参示例

用户通过门禁设备5秒钟以后,向梯控设备发送请求,把电梯呼叫到1层

{
  "dataId": "1c03a38c0db04f46a7e89ec1c3d9d8d5",
  "entranceIotId": "UOI0XOhjopEP1zkyZaDH000000",
  "entranceFloor": "1",
  "elevatorIotId": "qwJ7Ze0U02ktoQcs5LlS000100",
  "delaySeconds": 5,
  "executionNode": "EDGE"
}

出参示例

{
  "code": 200,
  "message": "success",
  "data": "1c03a38c0db04f46a7e89ec1c3d9d8d5"
}

5 删除设备数据

删除门禁设备和梯控设备的联动关系。

path

版本

是否需要登录

/elevator/entrance/device/delete

1.0.0

入参

入参

类型

是否必填

说明

dataId

String

代表联动关系的数据项id

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

入参示例

{
  "dataId": "1c03a38c0db04f46a7e89ec1c3d9d8d5"
}

出参示例

{
  "code": 200,
  "message": "success"
}

6 查询设备数据

查询门禁设备和梯控设备的联动关系。

path

版本

是否需要登录

/elevator/entrance/device/query

1.0.0

入参

入参

类型

是否必填

说明

dataId

String

代表联动关系的数据项id

出参

出参

类型

说明

code

Integer

响应码

message

String

响应消息

data

JSONObject

响应数据

- dataId

String

代表联动关系的数据项id

- entranceIotId

String

门禁设备id

- entranceFloor

String

门禁设备所在楼层

- elevatorIotId

String

梯控设备id

- elevatorDoor

Integer

数值型的电梯门枚举值,用于多门电梯的情况

- delaySeconds

Integer

延迟执行的秒数

- executionNode

String

执行节点,当前仅支持EDGE,即边缘执行

入参示例

{
  "dataId": "1c03a38c0db04f46a7e89ec1c3d9d8d5"
}

出参示例

{
  "code": 200,
  "message": "success",
  "data": {
    "dataId": "1c03a38c0db04f46a7e89ec1c3d9d8d5",
    "entranceIotId": "UOI0XOhjopEP1zkyZaDH000000",
    "entranceFloor": "1",
    "elevatorIotId": "qwJ7Ze0U02ktoQcs5LlS000100",
    "delaySeconds": 5,
    "executionNode": "EDGE"
  }
}

7 保存用户数据

在指定的联动关系下,保存门禁用户权限以及用户目标楼层和参数过期时间。该接口不会把权限下发给对应的门禁设备,调用方需另外使用门禁服务的接口下发门禁权限,否则无法实现联动。

path

版本

是否需要登录

/elevator/entrance/user/save

1.0.0

入参

入参

类型

是否必填

说明

dataId

String

代表联动关系的数据项id

paramType

String

用户参数类型,支持IDENTITY/QRCODE/CARD,分别表示人脸、二维码、刷卡权限

paramValue

String

用户参数值,由paramType决定其取值含义:

IDENTITY - 人脸用户的identityId

QRCODE - 二维码

CARD - 卡号

最大长度支持1024位。

userFloor

String

用户目标楼层

elevatorDoor

Integer

数值型的电梯门枚举值,用于多门电梯的情况,选填

0:A门

1:B门

expiryTime

String

参数过期时间,过期后参数自动失效,用于门禁权限(如二维码)带有效期的使用场景,不填则表示永久有效。格式:YYYY-MM-DD hh:mm:ss

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

入参示例

当用户使用二维码ALI7fcfd40d028eb刷码通过门禁设备时,请求梯控设备把电梯呼叫到门禁设备所在楼层,然后自动调度到10层。如果该二维码在2021年1月1日中午12点以后刷码通行,则不会自动触发呼梯。(门禁设备id、所在楼层以及梯控设备id和呼梯延时等参数在保存设备数据的接口中指定。)

{
  "dataId": "1c03a38c0db04f46a7e89ec1c3d9d8d5",
  "paramType": "QRCODE",
  "paramValue": "ALI7fcfd40d028eb",
  "userFloor": "10",
  "expiryTime": "2021-01-01 12:00:00"
}

出参示例

{
  "code": 200,
  "message": "success"
}

8 删除用户数据

在指定的联动关系下,删除门禁用户权限以及用户目标楼层和参数过期时间。该接口不会删除已经下发给门禁设备的权限数据。

path

版本

是否需要登录

/elevator/entrance/user/delete

1.0.0

入参

入参

类型

是否必填

说明

dataId

String

代表联动关系的数据项id

paramType

String

用户参数类型,支持IDENTITY/QRCODE/CARD,分别表示人脸、二维码、刷卡权限

paramValue

String

用户参数值,由paramType决定其取值含义:

IDENTITY - 人脸用户的identityId

QRCODE - 二维码

CARD - 卡号

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

入参示例

当用户使用二维码ALI7fcfd40d028eb刷码通过门禁设备时,不再触发呼梯。

{
  "dataId": "1c03a38c0db04f46a7e89ec1c3d9d8d5",
  "paramType": "QRCODE",
  "paramValue": "ALI7fcfd40d028eb"
}

出参示例

{
  "code": 200,
  "message": "success"
}

9 查询用户数据

在指定的联动关系下,查询门禁用户权限以及用户目标楼层和参数过期时间。

path

版本

是否需要登录

/elevator/entrance/user/query

1.0.0

入参

入参

类型

是否必填

说明

dataId

String

代表联动关系的数据项id

paramType

String

用户参数类型,支持IDENTITY/QRCODE/CARD,分别表示人脸、二维码、刷卡权限

paramValue

String

用户参数值,由paramType决定其取值含义:

IDENTITY - 人脸用户的identityId

QRCODE - 二维码

CARD - 卡号

出参

出参

类型

说明

code

Integer

响应码

message

String

响应消息

data

JSONObject

响应数据

- dataId

String

代表联动关系的数据项id

- paramType

String

用户参数类型

- paramValue

String

用户参数值

- userFloor

String

用户目标楼层

- elevatorDoor

Integer

数值型的电梯门枚举值,用于多门电梯的情况

- expiryTime

String

参数过期时间

入参示例

{
  "dataId": "1c03a38c0db04f46a7e89ec1c3d9d8d5",
  "paramType": "QRCODE",
  "paramValue": "ALI7fcfd40d028eb"
}

出参示例

{
  "code": 200,
  "message": "success",
  "data": {
    "dataId": "1c03a38c0db04f46a7e89ec1c3d9d8d5",
    "paramType": "QRCODE",
    "paramValue": "ALI7fcfd40d028eb",
    "userFloor": "10",
    "expiryTime": "2021-01-01 12:00:00"
  }
}