• 通用

通用

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(){
        //失敗回調
    }
})