- 通用
- 容器
- 设备
通用
-
1、页面引入js文件
https://jsapi.hecom.cn/scripts/hqapi-dist.js
-
2、全局变量、命名空间全局变量hq,命名空间:设备(hq.device)、业务(hq.biz)、数据(hq.internal)
-
3、权限验证配置[未实现]
红圈插件市场JS API安全验证,只有经过安全验证的插件才能调用安全级别较高的API,未经过验证的插件只能调用基础API。此接口尚未开放,请开发者提前做好准备。
hq.config({
appId: '', // 必填,微应用ID
corpId: '',//企业ID
timestamp: , // 必填,生成签名的时间戳
nonceStr: '', // 必填,生成签名的随机串
signature: ''// 必填,签名
}); -
4、通过ready接口处理成功验证
hq.ready(function(){
// 须把相关接口放在ready函数中调用来确保正确执行
// config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。
}); -
5、通过error接口处理失败验证[未实现]
hq.error(function(res){
// config信息验证失败会执行error函数,如签名过期导致验证失败
}); -
6、接口约定
所有接口都为异步
接受一个object类型的参数
成功回调 onSuccess
失败回调 onFail
hq.命名空间.功能.方法({
参数1: '',
参数2: '',
onSuccess: function(result) {
//成功回调
//所有返回信息都输出在这里
},
onFail: function(){
//失败回调
}
})