en_US English
en_US English zh_CN 简体中文
IM 2-553w338h

LKY蓝客云对接:恒拓智慧门锁发卡接口文档

•

lkyjd

.

门锁接口

.

版本号

修订日期

修订内容

说明

V1.0

2022-07-23

WebApi 接口

.

.

2022-12-28

增加读取卡号信息

修改回收卡房间 ID 及卡 ID 号二选一

.

V2.0.1

2023-02-04

升级回收卡接口检验参数

修改回收卡房间 ID 及卡 ID 号二选一

.

V2.0.2

2023-12-19

增加网关远程开锁

增加网关远程人脸数据下发到锁体

.

V2.0.3

2024-01-24

新增停用接口

.

门锁接口   1

使用说明   2

1.平台配置信息    3

1.1  获取平台房间数据信息    3

2.  卡片相关操作    4

2.1  发卡    4

2.2  回收卡    5

2.3.读卡号信息    6

2.  密码相关操作    7

2.1  生成密码（算法密码）    7

2.2  网关停用生成的密码(通过网关方式)    8

3.  网关下发密码相关操作    9

3.1  下发密码（在线密码）    9

3.2  停用下发密码    10

4.  网关远程开锁    11

4.1  远程开锁    11

5.  网关人脸相关操作    12

5.1  下发人脸数据至锁    12

5.2 停用下发的人脸    13

6.  网关指纹相关操作    14

6.1  下发指纹数据至锁    14

6.2 停用下发的指纹    15

使用说明

● 在平台【系统参数】–【开发管理】申请 appsecret  如图

LKY蓝客云对接:恒拓智慧门锁发卡接口文档插图

● 调用接口地址 http://127.0.0.1:19952

● 成功调用接口可在平台【查询报表】–【操作记录】查看调用结果

1.平台配置信息

.

1.1 获取平台房间数据信息

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GetRoomList‘ —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f’

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

rm_id

String

房间 ID

rm_name

String

房间名称

..

{

“code”: 1,

“msg”: “”,

“data”: [{

“rm_id“: “775032240849920”, “rm_name”: “1-101”

}, ]

}

2. 卡片相关操作

.

2.1  发卡

.

1.HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/MarkRoomCard‘ —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘abkp=2022-07-23 14:20:00′       —data–urlencode ‘unValid=2022-07-24 12:00:00‘

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

Long

Y

房间 ID

abkp

DateTime

Y

1.  当前授权房号的时间； 同卡此时间须一致 （否则会出现新卡顶替旧卡导致旧卡失效）

2.建议是当前时间，如果时间出现反转，如发 卡的时间比之前发的旧卡时间要晚则会出现 最新卡刷卡失败

unValid

DateTime

Y

卡片有效期结束时间

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

card_id

String

卡 ID 号

.

2.2 回收卡

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/ClearRoomCard‘ —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘card_id=03F56240′

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

String

N

房间 ID(选填)

card_id

String

N

卡号(选填)

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

card_id

String

卡 ID 号

rm_id

String

房间 ID 号

.

2.3.读卡号信息

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/ReadCard‘ —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f’

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

.

.

.

.

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

card_id

String

卡 ID 号

rm_id

Long

房间 ID

valid

Datetime

卡片有效期开始时间

unvalid

Datetime

卡片有效期结束时间

..

{

“code”: 1,

“msg”: “操作成功“,

“data”: {

“card_id”: “03F56240”,

“rm_id“: “775032240849920”,

“valid“: “2023-02-04 10:00:00″, “unvalid“: “2023-02-05 12:00:00″

}

}

2.  密码相关操作

.

2.1  生成密码（算法密码）

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/MakeOffline —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘unValid=2022-07-24 12:00:00′

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

String

Y

房间 ID

unValid

Datetime

Y

密码有效期结束时间

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

muid

String

密码

..

{

“code”: 1,

“msg”: “操作成功“, “data”: {

“muid”: “0356241”, }

}

2.2  网关停用生成的密码(通过网关方式)

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GatewayStopOffline —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘muid=0356241′

—data–urlencode ‘unValid=2022-07-24 12:00:00′

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

String

Y

房间 ID

muid

String

Y

生成的密码

unValid

Datetime

Y

密码有效期结束时间(必须是生成密码的结束时间)

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

.

.

.

.

3.  网关下发密码相关操作

.

3.1  下发密码（在线密码）

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GatewayUploadOnline —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘m1=1’

—data–urlencode ‘pwd=123456789′

—data–urlencode ‘unValid=2022-07-24 12:00:00′

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

String

Y

房间 ID

m1

Int

Y

序号(当重复时覆盖以前旧的密码)

pwd

String

Y

自定义密码(6-10 长度的数字)

unValid

Datetime

Y

有效期结束时间

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

ce

Int

锁体的剩余电量(单位%)

d2

Int8

当前时间戳

.

3.2  停用下发密码

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GatewayStopOnline —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘m1=1’

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

String

Y

房间 ID

m1

Int

Y

序号(必须是已经下发过的序号,若有误则可能会停用了其他)

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

ce

Int

锁体的剩余电量(单位%)

d2

Int8

当前时间戳

.

4.  网关远程开锁

.

4.1  远程开锁

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GatewayOpen —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

String

Y

房间 ID

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

ce

Int

锁体的剩余电量(单位%)

d2

Int8

当前时间戳

..

{

“code”: 1,

“msg”: “操作成功“, “data”: {

“ce”: 89,

“d2”: 1702979380980 }

}

5.  网关人脸相关操作

.

5.1  下发人脸数据至锁

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GatewayUploadFace —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘base64=xxxxxxxxx‘

—data–urlencode ‘m1=1’

—data–urlencode ‘abkp=2022-07-23 14:20:00′       —data–urlencode ‘unValid=2022-07-24 12:00:00‘

2.参数说明

.

名称

类型

是 否 必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

Long

Y

房间 ID

base64

String

Y

人脸图片数据。jpg 或 png 的 base64 格式数据

m1

Int

Y

序号范围(1-49),  多个人脸若相同序号则会覆盖最后一 个

abkp

DateTime

Y

当前有效期开始时间

unValid

DateTime

Y

有效期结束时间

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

ce

Int

锁体的剩余电量(单位%)

d2

Int8

当前时间戳

.

5.2 停用下发的人脸

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GatewayStopFace —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘m1=1’

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

String

Y

房间 ID

m1

Int

Y

序号(必须是已经下发过的序号,若有误则可能会停用了其他信息)

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

ce

Int

锁体的剩余电量(单位%)

d2

Int8

当前时间戳

.

6.  网关指纹相关操作

.

6.1  下发指纹数据至锁

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GatewayUploadFinger —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘hexs=ab–cd–ef–ee–ff‘

—data–urlencode ‘m1=1’

—data–urlencode ‘abkp=2022-07-23 14:20:00′       —data–urlencode ‘unValid=2022-07-24 12:00:00‘

2.参数说明

.

名称

类型

是 否 必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

Long

Y

房间 ID

hexs

String

Y

指纹数据,hex 格式

m1

Int

Y

序号范围(1-49),  多个人脸若相同序号则会覆盖最后一 个

abkp

DateTime

Y

当前有效期开始时间

unValid

DateTime

Y

有效期结束时间

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

ce

Int

锁体的剩余电量(单位%)

d2

Int8

当前时间戳

.

6.2 停用下发的指纹

.

1. HTTP 请求方法及示例.

POST, ContentType:application/json

.

curl —location -g —request POST ‘http://127.0.0.1:19952/Api/GatewayStopFinger —data–urlencode ‘appid=4773aa036f7f49c68d876bb4be85c80c’

—data–urlencode ‘appsecret=dfd5489d0cee31f0bdfaf59d0d42d71f‘ —data–urlencode ‘rm_id=775032240849920′

—data–urlencode ‘m1=1’

2.参数说明

.

名称

类型

是否必须

描述

appid

String

Y

平台分配 appid

appsecret

String

Y

平台申请的 appsecret

rm_id

String

Y

房间 ID

m1

Int

Y

序号(必须是已经下发过的序号,若有误则可能会停用了其他信息)

3.返回参数及示例

.

名称

类型

描述

code

Int

错误码:1 成功;非 1 失败

msg

String

错误信息

data

Object

名称

类型

描述

ce

Int

锁体的剩余电量(单位%)

d2

Int8

当前时间戳

.

•

我们将24小时内回复。
Cancel