|
微信JS-SDK說明文檔
概述微信JS-SDK是微信公眾平臺面向網(wǎng)頁開發(fā)者提供的基于微信內(nèi)的網(wǎng)頁開發(fā)工具包。 通過使用微信JS-SDK，網(wǎng)頁開發(fā)者可借助微信高效地使用拍照、選圖、語音、位置等手機系統(tǒng)的能力，同時可以直接使用微信分享、掃一掃、卡券、支付等微信特有的能力，為微信用戶提供更優(yōu)質(zhì)的網(wǎng)頁體驗。 此文檔面向網(wǎng)頁開發(fā)者介紹微信JS-SDK如何使用及相關(guān)注意事項。
使用說明在使用微信JS-SDK對應(yīng)的JS接口前，需確保公眾號已獲得使用對應(yīng)JS接口的權(quán)限，可登錄微信公眾平臺進入“開發(fā)者中心”查看對應(yīng)的接口權(quán)限。 注意： 所有的JS接口只能在公眾號綁定的域名下調(diào)用，公眾號開發(fā)者需要先登錄微信公眾平臺進入“公眾號設(shè)置”》“功能設(shè)置”里填寫“JS接口安全域名”。 步驟一：引入JS文件在需要調(diào)用JS接口的頁面引入如下JS文件，（支持https）：http://res.wx.qq.com/open/js/jweixin-1.0.0.js 備注：支持使用 AMD/CMD 標(biāo)準(zhǔn)模塊加載方法加載 步驟二：通過config接口注入權(quán)限驗證配置所有需要使用JS-SDK的頁面必須先注入配置信息，否則將無法調(diào)用（同一個url僅需調(diào)用一次，對于變化url的SPA的web app可在每次url變化時進行調(diào)用）。 wx.config({
debug: true, // 開啟調(diào)試模式,調(diào)用的所有api的返回值會在客戶端alert出來，若要查看傳入的參數(shù)，可以在pc端打開，參數(shù)信息會通過log打出，僅在pc端時才會打印。
appId: '', // 必填，公眾號的唯一標(biāo)識
timestamp: , // 必填，生成簽名的時間戳
nonceStr: '', // 必填，生成簽名的隨機串
signature: '',// 必填，簽名，見附錄1
jsApiList: [] // 必填，需要使用的JS接口列表，所有JS接口列表見附錄2
});
步驟三：通過ready接口處理成功驗證wx.ready(function(){
// config信息驗證后會執(zhí)行ready方法，所有接口調(diào)用都必須在config接口獲得結(jié)果之后，config是一個客戶端的異步操作，所以如果需要在頁面加載時就調(diào)用相關(guān)接口，則須把相關(guān)接口放在ready函數(shù)中調(diào)用來確保正確執(zhí)行。對于用戶觸發(fā)時才調(diào)用的接口，則可以直接調(diào)用，不需要放在ready函數(shù)中。
});
步驟四：通過error接口處理失敗驗證wx.error(function(res){
// config信息驗證失敗會執(zhí)行error函數(shù)，如簽名過期導(dǎo)致驗證失敗，具體錯誤信息可以打開config的debug模式查看，也可以在返回的res參數(shù)中查看，對于SPA可以在這里更新簽名。
});
接口調(diào)用說明所有接口通過wx對象(也可使用jWeixin對象)來調(diào)用，參數(shù)是一個對象，除了每個接口本身需要傳的參數(shù)之外，還有以下通用參數(shù)：
基礎(chǔ)接口判斷當(dāng)前客戶端版本是否支持指定JS接口wx.checkJsApi({
jsApiList: ['chooseImage'] // 需要檢測的JS接口列表，所有JS接口列表見附錄2,
success: function(res) {
// 以鍵值對的形式返回，可用的api值true，不可用為false
// 如：{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}
});
備注：checkJsApi接口是客戶端6.0.2新引入的一個預(yù)留接口，第一期開放的接口均可不使用checkJsApi來檢測。 分享接口請注意不要有誘導(dǎo)分享等違規(guī)行為，對于誘導(dǎo)分享行為將永久回收公眾號接口權(quán)限，詳細規(guī)則請查看：朋友圈管理常見問題 。 獲取“分享到朋友圈”按鈕點擊狀態(tài)及自定義分享內(nèi)容接口wx.onMenuShareTimeline({
title: '', // 分享標(biāo)題
link: '', // 分享鏈接
imgUrl: '', // 分享圖標(biāo)
success: function () {
// 用戶確認分享后執(zhí)行的回調(diào)函數(shù)
},
cancel: function () {
// 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
}
});
獲取“分享給朋友”按鈕點擊狀態(tài)及自定義分享內(nèi)容接口wx.onMenuShareAppMessage({
title: '', // 分享標(biāo)題
desc: '', // 分享描述
link: '', // 分享鏈接
imgUrl: '', // 分享圖標(biāo)
type: '', // 分享類型,music、video或link，不填默認為link
dataUrl: '', // 如果type是music或video，則要提供數(shù)據(jù)鏈接，默認為空
success: function () {
// 用戶確認分享后執(zhí)行的回調(diào)函數(shù)
},
cancel: function () {
// 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
}
});
獲取“分享到QQ”按鈕點擊狀態(tài)及自定義分享內(nèi)容接口wx.onMenuShareQQ({
title: '', // 分享標(biāo)題
desc: '', // 分享描述
link: '', // 分享鏈接
imgUrl: '' // 分享圖標(biāo)
success: function () {
// 用戶確認分享后執(zhí)行的回調(diào)函數(shù)
},
cancel: function () {
// 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
}
});
獲取“分享到騰訊微博”按鈕點擊狀態(tài)及自定義分享內(nèi)容接口wx.onMenuShareWeibo({
title: '', // 分享標(biāo)題
desc: '', // 分享描述
link: '', // 分享鏈接
imgUrl: '' // 分享圖標(biāo)
success: function () {
// 用戶確認分享后執(zhí)行的回調(diào)函數(shù)
},
cancel: function () {
// 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
}
});
圖像接口拍照或從手機相冊中選圖接口wx.chooseImage({
success: function (res) {
var localIds = res.localIds; // 返回選定照片的本地ID列表，localId可以作為img標(biāo)簽的src屬性顯示圖片
}
});
預(yù)覽圖片接口wx.previewImage({
current: '', // 當(dāng)前顯示的圖片鏈接
urls: [] // 需要預(yù)覽的圖片鏈接列表
});
上傳圖片接口wx.uploadImage({
localId: '', // 需要上傳的圖片的本地ID，由chooseImage接口獲得
isShowProgressTips: 1// 默認為1，顯示進度提示
success: function (res) {
var serverId = res.serverId; // 返回圖片的服務(wù)器端ID
}
});
備注：可用微信下載多媒體文件接口下載上傳的圖片，此處獲得的 serverId 即 media_id，參考文檔 ../12/58bfcfabbd501c7cd77c19bd9cfa8354.html
下載圖片接口wx.downloadImage({
serverId: '', // 需要下載的圖片的服務(wù)器端ID，由uploadImage接口獲得
isShowProgressTips: 1// 默認為1，顯示進度提示
success: function (res) {
var localId = res.localId; // 返回圖片下載后的本地ID
}
});
音頻接口開始錄音接口wx.startRecord(); 停止錄音接口wx.stopRecord({
success: function (res) {
var localId = res.localId;
}
});
監(jiān)聽錄音自動停止接口wx.onVoiceRecordEnd({
// 錄音時間超過一分鐘沒有停止的時候會執(zhí)行 complete 回調(diào)
complete: function (res) {
var localId = res.localId;
}
});
播放語音接口wx.playVoice({
localId: '' // 需要播放的音頻的本地ID，由stopRecord接口獲得
});
暫停播放接口wx.pauseVoice({
localId: '' // 需要暫停的音頻的本地ID，由stopRecord接口獲得
});
停止播放接口wx.stopVoice({
localId: '' // 需要停止的音頻的本地ID，由stopRecord接口獲得
});
監(jiān)聽語音播放完畢接口wx.onVoicePlayEnd({
serverId: '', // 需要下載的音頻的服務(wù)器端ID，由uploadVoice接口獲得
success: function (res) {
var localId = res.localId; // 返回音頻的本地ID
}
});
上傳語音接口wx.uploadVoice({
localId: '', // 需要上傳的音頻的本地ID，由stopRecord接口獲得
isShowProgressTips: 1// 默認為1，顯示進度提示
success: function (res) {
var serverId = res.serverId; // 返回音頻的服務(wù)器端ID
}
});
備注：可用微信下載多媒體文件接口下載上傳的語音，此處獲得的 serverId 即 media_id，參考文檔 ../12/58bfcfabbd501c7cd77c19bd9cfa8354.html
下載語音接口wx.downloadVoice({
serverId: '', // 需要下載的音頻的服務(wù)器端ID，由uploadVoice接口獲得
isShowProgressTips: 1// 默認為1，顯示進度提示
success: function (res) {
var localId = res.localId; // 返回音頻的本地ID
}
});
智能接口識別音頻并返回識別結(jié)果接口wx.translateVoice({
localId: '', // 需要識別的音頻的本地Id，由錄音相關(guān)接口獲得
isShowProgressTips: 1, // 默認為1，顯示進度提示
success: function (res) {
alert(res.translateResult); // 語音識別的結(jié)果
}
});
設(shè)備信息獲取網(wǎng)絡(luò)狀態(tài)接口wx.getNetworkType({
success: function (res) {
var networkType = res.networkType; // 返回網(wǎng)絡(luò)類型2g，3g，4g，wifi
}
});
地理位置使用微信內(nèi)置地圖查看位置接口wx.openLocation({
latitude: 0, // 緯度，浮點數(shù)，范圍為90 ~ -90
longitude: 0, // 經(jīng)度，浮點數(shù)，范圍為180 ~ -180。
name: '', // 位置名
address: '', // 地址詳情說明
scale: 1, // 地圖縮放級別,整形值,范圍從1~28。默認為最大
infoUrl: '' // 在查看位置界面底部顯示的超鏈接,可點擊跳轉(zhuǎn)
});
獲取地理位置接口wx.getLocation({
timestamp: 0, // 位置簽名時間戳，僅當(dāng)需要兼容6.0.2版本之前時提供
nonceStr: '', // 位置簽名隨機串，僅當(dāng)需要兼容6.0.2版本之前時提供
addrSign: '', // 位置簽名，僅當(dāng)需要兼容6.0.2版本之前時提供，詳見附錄4
success: function (res) {
var longitude = res.longitude; // 緯度，浮點數(shù)，范圍為90 ~ -90
var latitude = res.latitude; // 經(jīng)度，浮點數(shù)，范圍為180 ~ -180。
var speed = res.speed; // 速度，以米/每秒計
var accuracy = res.accuracy; // 位置精度
}
});
界面操作隱藏右上角菜單接口wx.hideOptionMenu(); 顯示右上角菜單接口wx.showOptionMenu(); 關(guān)閉當(dāng)前網(wǎng)頁窗口接口wx.closeWindow(); 批量隱藏功能按鈕接口wx.hideMenuItems({
menuList: [] // 要隱藏的菜單項，所有menu項見附錄3
});
批量顯示功能按鈕接口wx.showMenuItems({
menuList: [] // 要顯示的菜單項，所有menu項見附錄3
});
隱藏所有非基礎(chǔ)按鈕接口wx.hideAllNonBaseMenuItem(); 顯示所有功能按鈕接口wx.showAllNonBaseMenuItem(); 微信掃一掃調(diào)起微信掃一掃接口wx.scanQRCode({
desc: 'scanQRCode desc',
needResult: 0, // 默認為0，掃描結(jié)果由微信處理，1則直接返回掃描結(jié)果，
scanType: ["qrCode","barCode"], // 可以指定掃二維碼還是一維碼，默認二者都有
success: function (res) {
var result = res.resultStr; // 當(dāng)needResult 為 1 時，掃碼返回的結(jié)果
}
});
微信小店跳轉(zhuǎn)微信商品頁接口wx.openProductSpecificView({
productId: '', // 商品id
viewType: '' // 0.默認值，普通商品詳情頁1.掃一掃商品詳情頁2.小店商品詳情頁
});
微信卡券調(diào)起適用于門店的卡券列表并獲取用戶選擇列表wx.chooseCard({
shopId: '', // 門店Id
cardType: '', // 卡券類型
cardId: '', // 卡券Id
timeStamp: 0, // 卡券簽名時間戳
nonceStr: '', // 卡券簽名隨機串
cardSign: '', // 卡券簽名，詳見附錄6
success: function (res) {
var cardList= res.cardList; // 用戶選中的卡券列表信息
}
});
批量添加卡券接口wx.addCard({
cardList: [{
cardId: '',
cardExt: ''
}], // 需要添加的卡券列表
success: function (res) {
var cardList = res.cardList; // 添加的卡券列表信息
}
});
查看微信卡包中的卡券接口wx.openCard({
cardList: [{
cardId: '',
code: ''
}]// 需要打開的卡券列表
});
微信支付發(fā)起一個微信支付請求wx.chooseWXPay({
timestamp: 0, // 支付簽名時間戳
noncestr: '', // 支付簽名隨機串
package: '', // 訂單詳情擴展字符串，詳見附錄5
paySign: '', // 支付簽名，詳見附錄5
});
附錄1-JS-SDK使用權(quán)限簽名算法jsapi_ticket 生成簽名之前必須先了解一下jsapi_ticket，jsapi_ticket是公眾號用于調(diào)用微信JS接口的臨時票據(jù)。正常情況下，jsapi_ticket的有效期為7200秒，通過access_token來獲取。由于獲取jsapi_ticket的api調(diào)用次數(shù)非常有限，頻繁刷新jsapi_ticket會導(dǎo)致api調(diào)用受限，影響自身業(yè)務(wù)，開發(fā)者必須在自己的服務(wù)全局緩存jsapi_ticket 。
成功返回如下JSON： {
"errcode":0,
"errmsg":"ok",
"ticket":"bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
"expires_in":7200
}
獲得jsapi_ticket之后，就可以生成JS-SDK權(quán)限驗證的簽名了。
簽名算法 簽名生成規(guī)則如下：參與簽名的字段包括noncestr（隨機字符串）, 有效的jsapi_ticket, timestamp（時間戳）, url（當(dāng)前網(wǎng)頁的URL，不包含#及其后面部分） 。對所有待簽名參數(shù)按照字段名的ASCII 碼從小到大排序（字典序）后，使用URL鍵值對的格式（即key1=value1&key2=value2…）拼接成字符串string1。這里需要注意的是所有參數(shù)名均為小寫字符。對string1作sha1加密，字段名和字段值都采用原始值，不進行URL 轉(zhuǎn)義。
jsapi_ticket=sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg&noncestr=Wm3WZYTPz0wzccnW×tamp=1414587457&url=http://mp.weixin.qq.com
f4d90daf4b3bca3078ab155816175ba34c443a7b 注意事項
附錄2-所有JS接口列表版本1.0.0接口
附錄3-所有菜單項列表基本類
傳播類
保護類
附錄4-位置簽名生成算法addrSign的生成規(guī)則與JS-SDK權(quán)限驗證的簽名生成規(guī)則相同（參考附錄1），只是參與簽名參數(shù)有所不同。參與addrSign的簽名參數(shù)有：appId、url（當(dāng)前網(wǎng)頁url）、timestamp、noncestr、accesstoken（用戶授權(quán)憑證，請參照oauth2.0 協(xié)議獲?。?。
附錄5-支付擴展字段及簽名生成算法訂單詳情（package）擴展字符串定義 在商戶調(diào)起JS API 時，商戶需要此時確定該筆訂單詳情，并將該訂單詳情通過一定的方式進行組合放入package。JS API 調(diào)用后，微信將通過package 的內(nèi)容生成預(yù)支付單。下 面將定義package 的所需字段列表以及簽名方法。 接口需要注意：所有傳入?yún)?shù)都是字符串類型！ package 所需字段列表:
package 生成方法： 由于package中攜帶了生成訂單的詳細信息，因此在微信將對package里面的內(nèi)容進行鑒 權(quán)，確定package攜帶的信息是真實、有效、合理的。因此，這里將定義生成package字符 串的方法。
i: 經(jīng)過a過程URL鍵值對字典序排序后的字符串string1為： bank_type=WX&body=支付測試&fee_type=1&input_charset=UTF-8¬ify_url=http://we ixin.qq.com&out_trade_no=7240b65810859cbf2a8d9f76a638c0a3&partner=1900000109&spbill_ create_ip=196.168.1.1&total_fee=1 ii：經(jīng)過b過程后得到sign為： sign =md5(string1&key=8934e7d15453e97507ef794cf7b0519d).toUpperCase =md5(bank_type=WX&body=支付測試&fee_type=1&input_charset=UTF-8¬ify_url=htt p://weixin.qq.com&out_trade_no=7240b65810859cbf2a8d9f76a638c0a3&partner=1900000109& spbill_create_ip=196.168.1.1&total_fee=1&key=8934e7d15453e97507ef794cf7b0519d).toUpper Case() ="7f77b507b755b3262884291517e380f8".toUpperCase() ="7F77B507B755B3262884291517E380F8" iii：再對傳入?yún)?shù)中的每一個鍵值對中的value進行urlencode編碼后得到： bank_type=WX&body=%E6%94%AF%E4%BB%98%E6%B5%8B%E8%AF%95&fee_typ e=1&input_charset=UTF-8¬ify_url=http%3A%2F%2Fweixin.qq.com&out_trade_no=7240b6 5810859cbf2a8d9f76a638c0a3&partner=1900000109&spbill_create_ip=196.168.1.1&total_fee=1 iv：拼接上sign后得到最終package結(jié)果： bank_type=WX&body=%E6%94%AF%E4%BB%98%E6%B5%8B%E8%AF%95&fee_typ e=1&input_charset=UTF-8¬ify_url=http%3A%2F%2Fweixin.qq.com&out_trade_no=7240b6 5810859cbf2a8d9f76a638c0a3&partner=1900000109&spbill_create_ip=196.168.1.1&total_fee=1 &sign=7F77B507B755B3262884291517E380F8
paySign字段是對本次發(fā)起JSAPI的行為進行鑒權(quán)，只有通過了paySign鑒權(quán)，才能繼 續(xù)對package鑒權(quán)并生成預(yù)支付單。paySign的生成規(guī)則與JS-SDK權(quán)限驗證的簽名生成規(guī)則相同（參考附錄1）。
附錄6-卡券擴展字段及簽名生成算法卡券擴展字段cardExt說明 cardExt本身是一個JSON字符串，是商戶為該張卡券分配的唯一性信息，包含以下字段：
簽名說明
卡券簽名cardSign說明
附錄7-常見錯誤及解決方法調(diào)用config 接口的時候傳入?yún)?shù) debug: true 可以開啟debug模式，頁面會alert出錯誤信息。以下為常見錯誤及解決方法：
附錄8-DEMO頁面和示例代碼DEMO頁面： http://demo.open.weixin.qq.com/jssdk 
http://demo.open.weixin.qq.com/jssdk/sample.zip 備注：鏈接中包含php、java、nodejs以及python的示例代碼供第三方參考，第三方切記要對獲取的accesstoken以及jsapi_ticket進行緩存以確保不會觸發(fā)頻率限制。 附錄9-問題反饋郵箱地址：weixin-open@qq.com 郵件主題：【微信JS-SDK反饋】 郵件內(nèi)容說明： 用簡明的語言描述問題所在，并交代清楚遇到該問題的場景，可附上截屏圖片，微信團隊會盡快處理你的反饋。 |
|
|
來自： andorcba > 《javascript》
