接入指南
准备工作
注册开发者账号 https://open.zhiguohulian.com 并创建应用
注意
jssdk 只是封装后端接口，如需要更好的自由度，可自行对接后端接口
引入js文件
请在页面引入js文件： https://open.zhiguohulian.com/static/jssdk/release/1.0.3/jssdk.js
引入 jssdk.js 会得到一个全局变量 ZGHL
注意
仅支持https
jssdk使用了Promise，如果需要兼容低版本浏览器，请自行添加 polyfill
调用jsapi
调用jsapi实例之前请确保已经拿到授权信息 {refresh_token, access_token, token_type, expires, host} 授权接口请参见 （注：grant_type为client_credentials）
拿到相关授权之后就可以调用jsapi，如下：
const zghl = new ZGHL({
authInfo:{
refresh_url: "https://openapi.zhiguohulian.com/openapi/v1/oauth/token",
refresh_token: "",
access_token: "",
token_type: "",
expires: "",
host: ""
},
// ready 回调
onReady () {
},
// 初始化错误回调
onError (errMsg) {
}
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
回调事件
// 常规错误
zghl.on('error', (errMsg)=>{
})
// 缺少参数
zghl.on('missParamError', ({action, params})=> {
})
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
接口约定
- 所有接口都为异步
- 接口返回结构
{
code: '', // 状态码，详见下表
msg: '', // 状态码说明
data: '' // 返回数据
}
1
2
3
4
5
2
3
4
5
状态码
| 状态码 | 说明 |
|---|---|
| 200 | ok |
| 1001 | 手机号码错误 |
| 1002 | 验证码错误 |
| 1003 | 身份信息未验证通过 |
| 1004 | 操作过于频繁请一个小时后再试 |
| 1005 | 验证码发送失败请尝试再试 |
| 1006 | 登录校验失败，请重新登录 |
| 1007 | 无管辖的小区 |
| 1008 | 小区名称不能为空 |
| 1009 | 小区不存在 |
| 1010 | 楼栋不存在 |
| 1011 | 请选择申请类型 |
| 1012 | 请选择身份 |
| 1013 | 姓名不能为空，且30个字符内 |
| 1014 | 身份证格式不对 |
| 1015 | 请先选择小区、楼栋和房号 |
| 1016 | 申请失败，请重试 |
| 1017 | 所选房号不存在 |
| 1018 | 申请失败，请重试 |
| 1019 | 暂无申请记录 |
| 1020 | 参数非法 |
| 1021 | 钥匙不存在 |
| 1022 | 更新常用钥匙失败，请重试 |
| 1023 | 您还没有绑定房间 |
| 1024 | 免打扰设置失败，请重试 |
| 1025 | 房间不存在 |
| 1026 | 操作非法 |
| 1027 | 设置转接号码失败，请稍后重试 |
| 1028 | 钥匙已过期 |
| 1029 | 门禁机不存在 |
| 1030 | 访客密码生成失败，请稍后重试 |
| 1031 | 没有可用的钥匙 |
| 1032 | 用户与房间的绑定关系不存在 |
| 1033 | 今日申请访客密码次数已达上限20次 |
| 1034 | 已经是最新版本 |
| 1035 | 获取不到有用的访客密码 |
| 1036 | 短信分享失败，请重试 |
| 1037 | 反馈出现异常，请重试 |
| 1038 | 反馈内容或图片不能全为空 |
| 1039 | 手机型号或app名称不能为空 |
| 1040 | 钥匙还未过期，不能删除 |
| 1041 | 钥匙续期正在审核中，不能删除 |
| 1042 | 钥匙删除失败，请重试 |
| 1043 | 智能锁名称不能为空 |
| 1044 | 智能锁设备id不能为空 |
| 1045 | 智能锁电量字段不能为空 |
| 1046 | 该智能锁已被绑定 |
| 1047 | 智能锁绑定失败，请重试 |
| 1048 | 智能锁不存在，请重试 |
| 1049 | 只有管理员才可以更新智能锁的资料 |
| 1050 | 更新智能锁资料失败，请重试 |
| 1051 | 门锁名称最多10个汉字 |
| 1052 | 管理员开锁密码不能为空 |
| 1053 | 开锁密码是4-9位的纯数字 |
| 1054 | 用户与智能锁的绑定关系已不存在 |
| 1055 | 解除绑定失败，请重试 |
| 1056 | 开锁密码类型不能为空，且只能是单次或限时类型 |
| 1057 | 到期时间不能为空，且不能小于当前时间 |
| 1058 | 生成开锁密码失败，请重试 |
| 1059 | 该记录不存在，请重试 |
| 1060 | 授权手机号格式不对 |
| 1061 | 授权类型不能为空，且只能是永久或限时授权 |
| 1062 | 授权时间不能为空，且开始时间必须小于结束时间 |
| 1063 | 只有管理员才有权限授权 |
| 1064 | 授权失败，请重试 |
| 1065 | 授权关系不存在 |
| 1066 | 删除授权关系失败，请重试 |
| 1067 | IC卡名称不能为空，且最多10个汉字 |
| 1068 | IC卡授权类型不能为空，且只能是限时或永久的 |
| 1069 | IC卡添加失败，请重试 |
| 1070 | IC卡不存在 |
| 1071 | IC卡删除失败，请重试 |
| 1072 | IC卡号不能为空 |
| 1073 | 指纹名称不能为空，且最多10个汉字 |
| 1074 | 指纹授权类型不能为空，且只能是限时或永久的 |
| 1075 | 指纹添加失败，请重试 |
| 1076 | 指纹不存在 |
| 1077 | 指纹删除失败，请重试 |
| 1078 | 指纹数据不能为空 |
| 1079 | 开锁记录方式不对 |
| 1080 | 开锁记录备注不能为空 |
| 1081 | 开锁记录添加失败，请重试 |
| 1082 | 操作失败，请重试 |
| 1083 | 您已是管理员了，请不要重复授权 |
| 1084 | 设备不存在，请重试 |
| 1085 | 抱歉，您没有该门禁的开门权限 |
| 1086 | access_token无效 |
| 1087 | access_token已过期 |
| 1088 | 用户信息不存在 |
| 1089 | 更新公告已读失败 |
| 1090 | 网关验证失败，请使用验证码验证 |
| 1091 | 网关校验事件的流水号错误 |
| 1092 | 网关校验事件分配的token错误 |
| 1093 | 短信唯一编号错误 |
| 1094 | 公告信息不存在 |
| 1095 | 该手机号存在指纹门锁授权信息 |
| 1096 | 该用户已经是业主不能授权 |
| 1097 | 您不是业主，不能授权 |
| 1098 | 授权失败，稍后再试试 |
| 1099 | 授权的身份有误，请重新选择 |
| 1100 | 国家代码json文件不存在 |
| 1101 | 国家代码不在开通的白名单内 |
| 1102 | 删除授权失败 |
| 1103 | 该小区还未开启授权权限 |
| 2001 | 本小区已经抢购过！ |
| 2002 | 未找到对应的商品 |
| 2003 | 抱歉，本小区没参与试用 |
| 2004 | 很遗憾，您没抢到试用产品 |
| 2005 | 很遗憾，找不到对应的订单 |
| 2006 | 订单不是未支付状态 |
| 2007 | 支付金额不对 |
| 2008 | 微信支付发起失败 |
| 2009 | 请求参数有误！ |
| 2010 | 抱歉，该用户未注册我们app！ |
| 2011 | 没找到相关的房屋信息！ |
| 2012 | 操作失败，请重新试试！ |
| 2013 | 订单不存在！ |
| 2014 | 该订单已经开过发票！ |
| 2015 | 该订单不能退款！请联系客服 |
| 2016 | 锁厚度数字有错或者不能大于四位数 |
| 2017 | 锁宽度数字有错或者不能大于四位数 |
| 2018 | 锁高度数字有错或者不能大于四位数 |
| 2019 | 您已经抽过，请家人也来抽奖吧！ |
| 3001 | 用户未注册人脸 |
| 3002 | 人脸图片错误 |
| 3003 | 人脸注册失败 |
| 3004 | 用户人脸不存在 |
| 3005 | 人脸删除失败 |
| 3006 | 人脸图片质量不佳 |
| 3007 | 未检测到人脸 |
| 3008 | 检测到多张人脸 |
更新日志
1.0.3 修复小程序支持问题