步驟一:引入js文件api
jsapp
步驟二:經過config接口注入權限驗證配置異步
wx.config({ide
debug: true, // 開啓調試模式,調用的全部api的返回值會在客戶端alert出來,若要查看傳入的參數,能夠在pc端打開,參數信息會經過log打出,僅在pc端時纔會打印。
appId: '', // 必填,公衆號的惟一標識
timestamp: '', // 必填,生成簽名的時間戳
nonceStr: '', // 必填,生成簽名的隨機串
signature: '',// 必填,簽名,見附錄1
jsApiList: [] // 必填,須要使用的JS接口列表,全部JS接口列表見附錄2
});
步驟三:經過ready接口處理成功驗證
wx.ready(function () {
// config信息驗證後會執行ready方法,全部接口調用都必須在config接口得到結果以後,config是一個客戶端的異步操做,因此若是須要在頁面加載時就調用相關接口,則須把相關接口放在ready函數中調用來確保正確執行。對於用戶觸發時才調用的接口,則能夠直接調用,不須要放在ready函數中。
});
步驟四:經過error接口處理失敗驗證
wx.error(function (res) {
// config信息驗證失敗會執行error函數,如簽名過時致使驗證失敗,具體錯誤信息能夠打開config的debug模式查看,也能夠在返回的res參數中查看,對於SPA能夠在這裏更新簽名。
});
接口說明
//接口調用說明
// 全部接口經過wx對象(也可以使用jWeixin對象)來調用,參數是一個對象,除了每一個接口自己須要傳的參數以外,還有如下通用參數:
//
// success:接口調用成功時執行的回調函數。
// fail:接口調用失敗時執行的回調函數。
// complete:接口調用完成時執行的回調函數,不管成功或失敗都會執行。
// cancel:用戶點擊取消時的回調函數,僅部分有用戶取消操做的api纔會用到。
// trigger: 監聽Menu中的按鈕點擊時觸發的方法,該方法僅支持Menu中的相關接口。
//
// 以上幾個函數都帶有一個參數,類型爲對象,其中除了每一個接口自己返回的數據以外,還有一個通用屬性errMsg,其值格式以下:
//
// 調用成功時:"xxx:ok" ,其中xxx爲調用的接口名
// 用戶取消時:"xxx:cancel",其中xxx爲調用的接口名
// 調用失敗時:其值爲具體錯誤信息
基礎接口
判斷當前客戶端版本是否支持指定JS接口
wx.checkJsApi({
jsApiList: ['chooseImage'],
success: function(res) {
// 以鍵值對的形式返回,可用的api值true,不可用爲false
//{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}
}
});
// 備註:checkJsApi接口是客戶端6.0.2新引入的一個預留接口,第一期開放的接口都可不使用checkJsApi來檢測。
分享接口
// 獲取「分享到朋友圈」按鈕點擊狀態及自定義分享內容接口
wx.onMenuShareTimeline({
title: '', // 分享標題
link: '', // 分享連接
imgUrl: '', // 分享圖標
success: function () {
// 用戶確認分享後執行的回調函數
},
cancel: function () {
// 用戶取消分享後執行的回調函數
}
});
// 獲取「分享給朋友」按鈕點擊狀態及自定義分享內容接口
wx.onMenuShareAppMessage({
title: '', // 分享標題
desc: '', // 分享描述
link: '', // 分享連接
imgUrl: '', // 分享圖標
type: '', // 分享類型,music、video或link,不填默認爲link
dataUrl: '', // 若是type是music或video,則要提供數據連接,默認爲空
success: function () {
// 用戶確認分享後執行的回調函數
},
cancel: function () {
// 用戶取消分享後執行的回調函數
}
});
wx.error(function (res) { alert(res.errMsg);});