微信JS SDK 調用詳解... 1php
概述... 2html
使用說明... 2前端
接口調用說明... 4java
基礎接口... 4node
判斷當前客戶端版本是否支持指定JS接口... 5python
分享接口... 5git
獲取「分享到朋友圈」按鈕點擊狀態及自定義分享內容接口... 5web
獲取「分享給朋友」按鈕點擊狀態及自定義分享內容接口... 5算法
獲取「分享到QQ」按鈕點擊狀態及自定義分享內容接口... 6api
獲取「分享到騰訊微博」按鈕點擊狀態及自定義分享內容接口... 6
圖像接口... 7
拍照或從手機相冊中選圖接口... 7
預覽圖片接口... 7
上傳圖片接口... 7
下載圖片接口... 8
音頻接口... 8
開始錄音接口... 8
中止錄音接口... 8
監聽錄音自動中止接口... 8
播放語音接口... 9
暫停播放接口... 9
中止播放接口... 9
監聽語音播放完畢接口... 9
上傳語音接口... 9
下載語音接口... 10
智能接口... 10
識別音頻並返回識別結果接口... 10
設備信息... 10
獲取網絡狀態接口... 11
地理位置... 11
使用微信內置地圖查看位置接口... 11
獲取地理位置接口... 11
界面操做... 12
隱藏右上角菜單接口... 12
顯示右上角菜單接口... 12
關閉當前網頁窗口接口... 12
批量隱藏功能按鈕接口... 12
批量顯示功能按鈕接口... 12
隱藏全部非基礎按鈕接口... 12
顯示全部功能按鈕接口... 12
微信掃一掃... 13
調起微信掃一掃接口... 13
微信小店... 13
跳轉微信商品頁接口... 13
微信卡券... 13
調起適用於門店的卡券列表並獲取用戶選擇列表... 13
批量添加卡券接口... 14
查看微信卡包中的卡券接口... 14
微信支付... 14
發起一個微信支付請求... 14
附錄1-JS-SDK使用權限簽名算法... 15
附錄2-全部JS接口列表... 17
附錄3-全部菜單項列表... 18
附錄4-位置簽名生成算法... 18
附錄5-支付擴展字段及簽名生成算法... 19
附錄6-卡券擴展字段及簽名生成算法... 23
附錄7-常見錯誤及解決方法... 24
附錄8-DEMO頁面和示例代碼... 24
附錄9-問題反饋... 25
概述
微信JS-SDK是微信公衆平臺面向網頁開發者提供的基於微信內的網頁開發工具包。
經過使用微信JS-SDK,網頁開發者可藉助微信高效地使用拍照、選圖、語音、位置等手機系統的能力,同時能夠直接使用微信分享、掃一掃、卡券、支付等微信特有的能力,爲微信用戶提供更優質的網頁體驗。
此文檔面向網頁開發者介紹微信JS-SDK如何使用及相關注意事項。
使用說明
在使用微信JS-SDK對應的JS接口前,需確保公衆號已得到使用對應JS接口的權限,可登陸微信公衆平臺進入「開發者中心」查看對應的接口權限。
注意: 全部的JS接口只能在公衆號綁定的域名下調用,公衆號開發者須要先登陸微信公衆平臺進入「公衆號設置」》「功能設置」裏填寫「JS接口安全域名」。
步驟一:引入JS文件
在須要調用JS接口的頁面引入以下JS文件,(支持https):http://res.wx.qq.com/open/js/jweixin-1.0.0.js
備註:支持使用 AMD/CMD 標準模塊加載方法加載
步驟二:經過config接口注入權限驗證配置
全部須要使用JS-SDK的頁面必須先注入配置信息,不然將沒法調用(同一個url僅需調用一次,對於變化url的SPA的web app可在每次url變化時進行調用)。
wx.config({
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對象)來調用,參數是一個對象,除了每一個接口自己須要傳的參數以外,還有如下通用參數:
以上幾個函數都帶有一個參數,類型爲對象,其中除了每一個接口自己返回的數據以外,還有一個通用屬性errMsg,其值格式以下:
基礎接口
判斷當前客戶端版本是否支持指定JS接口
wx.checkJsApi({
jsApiList: ['chooseImage'] // 須要檢測的JS接口列表,全部JS接口列表見附錄2,
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 () {
// 用戶取消分享後執行的回調函數
}
});
獲取「分享到QQ」按鈕點擊狀態及自定義分享內容接口
wx.onMenuShareQQ({
title: '', // 分享標題
desc: '', // 分享描述
link: '', // 分享連接
imgUrl: '' // 分享圖標
success: function () {
// 用戶確認分享後執行的回調函數
},
cancel: function () {
// 用戶取消分享後執行的回調函數
}
});
獲取「分享到騰訊微博」按鈕點擊狀態及自定義分享內容接口
wx.onMenuShareWeibo({
title: '', // 分享標題
desc: '', // 分享描述
link: '', // 分享連接
imgUrl: '' // 分享圖標
success: function () {
// 用戶確認分享後執行的回調函數
},
cancel: function () {
// 用戶取消分享後執行的回調函數
}
});
圖像接口
拍照或從手機相冊中選圖接口
wx.chooseImage({
success: function (res) {
var localIds = res.localIds; // 返回選定照片的本地ID列表,localId能夠做爲img標籤的src屬性顯示圖片
}
});
預覽圖片接口
wx.previewImage({
current: '', // 當前顯示的圖片連接
urls: [] // 須要預覽的圖片連接列表
});
上傳圖片接口
wx.uploadImage({
localId: '', // 須要上傳的圖片的本地ID,由chooseImage接口得到
isShowProgressTips: 1// 默認爲1,顯示進度提示
success: function (res) {
var serverId = res.serverId; // 返回圖片的服務器端ID
}
});
備註:可用微信下載多媒體文件接口下載上傳的圖片,此處得到的 serverId 即 media_id,參考文檔 ../12/58bfcfabbd501c7cd77c19bd9cfa8354.html
下載圖片接口
wx.downloadImage({
serverId: '', // 須要下載的圖片的服務器端ID,由uploadImage接口得到
isShowProgressTips: 1// 默認爲1,顯示進度提示
success: function (res) {
var localId = res.localId; // 返回圖片下載後的本地ID
}
});
音頻接口
開始錄音接口
wx.startRecord();
中止錄音接口
wx.stopRecord({
success: function (res) {
var localId = res.localId;
}
});
監聽錄音自動中止接口
wx.onVoiceRecordEnd({
// 錄音時間超過一分鐘沒有中止的時候會執行 complete 回調
complete: function (res) {
var localId = res.localId;
}
});
播放語音接口
wx.playVoice({
localId: '' // 須要播放的音頻的本地ID,由stopRecord接口得到
});
暫停播放接口
wx.pauseVoice({
localId: '' // 須要暫停的音頻的本地ID,由stopRecord接口得到
});
中止播放接口
wx.stopVoice({
localId: '' // 須要中止的音頻的本地ID,由stopRecord接口得到
});
監聽語音播放完畢接口
wx.onVoicePlayEnd({
serverId: '', // 須要下載的音頻的服務器端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; // 返回音頻的服務器端ID
}
});
備註:可用微信下載多媒體文件接口下載上傳的語音,此處得到的 serverId 即 media_id,參考文檔 ../12/58bfcfabbd501c7cd77c19bd9cfa8354.html
下載語音接口
wx.downloadVoice({
serverId: '', // 須要下載的音頻的服務器端ID,由uploadVoice接口得到
isShowProgressTips: 1// 默認爲1,顯示進度提示
success: function (res) {
var localId = res.localId; // 返回音頻的本地ID
}
});
智能接口
識別音頻並返回識別結果接口
wx.translateVoice({
localId: '', // 須要識別的音頻的本地Id,由錄音相關接口得到
isShowProgressTips: 1, // 默認爲1,顯示進度提示
success: function (res) {
alert(res.translateResult); // 語音識別的結果
}
});
設備信息
獲取網絡狀態接口
wx.getNetworkType({
success: function (res) {
var networkType = res.networkType; // 返回網絡類型2g,3g,4g,wifi
}
});
地理位置
使用微信內置地圖查看位置接口
wx.openLocation({
latitude: 0, // 緯度,浮點數,範圍爲90 ~ -90
longitude: 0, // 經度,浮點數,範圍爲180 ~ -180。
name: '', // 位置名
address: '', // 地址詳情說明
scale: 1, // 地圖縮放級別,整形值,範圍從1~28。默認爲最大
infoUrl: '' // 在查看位置界面底部顯示的超連接,可點擊跳轉
});
獲取地理位置接口
wx.getLocation({
timestamp: 0, // 位置簽名時間戳,僅當須要兼容6.0.2版本以前時提供
nonceStr: '', // 位置簽名隨機串,僅當須要兼容6.0.2版本以前時提供
addrSign: '', // 位置簽名,僅當須要兼容6.0.2版本以前時提供,詳見附錄4
success: function (res) {
var longitude = res.longitude; // 緯度,浮點數,範圍爲90 ~ -90
var latitude = res.latitude; // 經度,浮點數,範圍爲180 ~ -180。
var speed = res.speed; // 速度,以米/每秒計
var accuracy = res.accuracy; // 位置精度
}
});
界面操做
隱藏右上角菜單接口
wx.hideOptionMenu();
顯示右上角菜單接口
wx.showOptionMenu();
關閉當前網頁窗口接口
wx.closeWindow();
批量隱藏功能按鈕接口
wx.hideMenuItems({
menuList: [] // 要隱藏的菜單項,全部menu項見附錄3
});
批量顯示功能按鈕接口
wx.showMenuItems({
menuList: [] // 要顯示的菜單項,全部menu項見附錄3
});
隱藏全部非基礎按鈕接口
wx.hideAllNonBaseMenuItem();
顯示全部功能按鈕接口
wx.showAllNonBaseMenuItem();
微信掃一掃
調起微信掃一掃接口
wx.scanQRCode({
desc: 'scanQRCode desc',
needResult: 0, // 默認爲0,掃描結果由微信處理,1則直接返回掃描結果,
scanType: ["qrCode","barCode"], // 能夠指定掃二維碼仍是一維碼,默認兩者都有
success: function (res) {
var result = res.resultStr; // 當needResult 爲 1 時,掃碼返回的結果
}
});
微信小店
跳轉微信商品頁接口
wx.openProductSpecificView({
productId: '', // 商品id
viewType: '' // 0.默認值,普通商品詳情頁1.掃一掃商品詳情頁2.小店商品詳情頁
});
微信卡券
調起適用於門店的卡券列表並獲取用戶選擇列表
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: ''
}]// 須要打開的卡券列表
});
微信支付
發起一個微信支付請求
wx.chooseWXPay({
timestamp: 0, // 支付簽名時間戳
noncestr: '', // 支付簽名隨機串
package: '', // 訂單詳情擴展字符串,詳見附錄5
paySign: '', // 支付簽名,詳見附錄5
});
附錄1-JS-SDK使用權限簽名算法
jsapi_ticket
生成簽名以前必須先了解一下jsapi_ticket,jsapi_ticket是公衆號用於調用微信JS接口的臨時票據。正常狀況下,jsapi_ticket的有效期爲7200秒,經過access_token來獲取。因爲獲取jsapi_ticket的api調用次數很是有限,頻繁刷新jsapi_ticket會致使api調用受限,影響自身業務,開發者必須在本身的服務全局緩存jsapi_ticket 。
成功返回以下JSON:
{
"errcode":0,
"errmsg":"ok",
"ticket":"bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
"expires_in":7200
}
得到jsapi_ticket以後,就能夠生成JS-SDK權限驗證的簽名了。
簽名算法
簽名生成規則以下:參與簽名的字段包括noncestr(隨機字符串), 有效的jsapi_ticket, timestamp(時間戳), url(當前網頁的URL,不包含#及其後面部分) 。對全部待簽名參數按照字段名的ASCII 碼從小到大排序(字典序)後,使用URL鍵值對的格式(即key1=value1&key2=value2…)拼接成字符串string1。這裏須要注意的是全部參數名均爲小寫字符。對string1做sha1加密,字段名和字段值都採用原始值,不進行URL 轉義。
即signature=sha1(string1)。 示例:
步驟1. 對全部待簽名參數按照字段名的ASCII 碼從小到大排序(字典序)後,使用URL鍵值對的格式(即key1=value1&key2=value2…)拼接成字符串string1:
jsapi_ticket=sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg&noncestr=Wm3WZYTPz0wzccnW×tamp=1414587457&url=http://mp.weixin.qq.com
步驟2. 對string1進行sha1簽名,獲得signature:
f4d90daf4b3bca3078ab155816175ba34c443a7b
注意事項
附錄2-全部JS接口列表
版本1.0.0接口
附錄3-全部菜單項列表
基本類
傳播類
保護類
附錄4-位置簽名生成算法
addrSign的生成規則與JS-SDK權限驗證的簽名生成規則相同(參考附錄1),只是參與簽名參數有所不一樣。參與addrSign的簽名參數有:appId、url(當前網頁url)、timestamp、noncestr、accesstoken(用戶受權憑證,請參照oauth2.0 協議獲取)。
附錄5-支付擴展字段及簽名生成算法
訂單詳情(package)擴展字符串定義
在商戶調起JS API 時,商戶須要此時肯定該筆訂單詳情,並將該訂單詳情經過必定的方式進行組合放入package。JS API 調用後,微信將經過package 的內容生成預支付單。下 面將定義package 的所需字段列表以及簽名方法。 接口須要注意:全部傳入參數都是字符串類型!
package 所需字段列表:
參數 |
名稱 |
是否必填 |
格式 |
說明 |
bank_type |
銀行通道類型 |
是 |
字符串類型,固定爲"WX",注意大寫 |
固定爲"WX"; |
body |
商品描述 |
是 |
字符串類型,128字節如下 |
商品描述; |
attach |
附加數據 |
否 |
字符串類型,128字節如下 |
附加數據,原樣返回; |
partner |
商戶號 |
是 |
字符串類型 |
字符串類型註冊時分配的財付通商戶號partnerId; |
out_trade_no |
商戶訂單號 |
是 |
字符串類型,32字節如下 |
商戶系統內部的訂單號,32 個字符內、可包含字母;確保在商戶系統惟一 |
total_fee |
訂單總金額 |
是 |
字符串類型 |
訂單總金額,單位爲分; |
fee_type |
支付幣種 |
是 |
字符串類型,默認值是"1" |
取值:1(人民幣),暫只支持1; |
notify_url |
通知URL |
是 |
字符串類型,255字節如下 |
在支付完成後,接收微信通知支付結果的URL,需給絕對路徑, 255 字符內, 格式如:http://wap.tenpay.com/tenpay.asp; |
spbill_create_ip |
訂單生成的機器IP |
是 |
字符串類型,15字節如下 |
指用戶瀏覽器端IP,不是商戶服務器IP,格式爲IPV4; |
time_start |
交易起始時間 |
否 |
字符串類型,14字節如下 |
訂單生成時間,格式爲yyyyMMddHHmmss,如2009 年12 月25 日9 點10 分10 秒錶示爲20091225091010,時區爲GMT+8 beijing;該時間取自商戶服務器; |
time_expire |
交易結束時間 |
否 |
字符串類型,14字節如下 |
訂單失效時間,格式爲yyyyMMddHHmmss,如2009 年12 月27 日9 點10 分10 秒錶示爲20091227091010,時區爲GMT+8 beijing;該時間取自商戶服務器; |
transport_fee |
物流費用 |
否 |
字符串類型 |
物流費用,單位爲分。若是有值,必須保證 transport_fee + product_fee=total_fee; |
product_fee |
商品費用 |
否 |
字符串類型 |
物流費用,單位爲分。若是有值,必須保證 transport_fee + product_fee=total_fee; |
goods_tag |
商品標記 |
否 |
字符串類型 |
商品標記,優惠券時可能用到; |
input_charset |
傳入參數字符編碼 |
是 |
字符串類型 |
取值範圍:"GBK"、"UTF-8",默認:"GBK" |
package 生成方法: 因爲package中攜帶了生成訂單的詳細信息,所以在微信將對package裏面的內容進行鑑 權,肯定package攜帶的信息是真實、有效、合理的。所以,這裏將定義生成package字符 串的方法。
下面定義了一段生成package字符串的示範過程: 假設如下爲package傳入參數:
i: 通過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:通過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:再對傳入參數中的每個鍵值對中的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結果:
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)生成方法
paySign字段是對本次發起JSAPI的行爲進行鑑權,只有經過了paySign鑑權,才能繼 續對package鑑權並生成預支付單。paySign的生成規則與JS-SDK權限驗證的簽名生成規則相同(參考附錄1)。
參與paySign簽名的字段包括:appid、timestamp、noncestr、package以及appkey(即 paySignkey)。
附錄6-卡券擴展字段及簽名生成算法
卡券擴展字段cardExt說明
cardExt自己是一個JSON字符串,是商戶爲該張卡券分配的惟一性信息,包含如下字段:
字段 |
是否必填 |
說明 |
code |
否 |
指定的卡券code碼,只能被領一次。use_custom_code字段爲true的卡券必須填寫,非自定義code沒必要填寫。 |
openid |
否 |
指定領取者的openid,只有該用戶能領取。bind_openid字段爲true的卡券必須填寫,非自定義openid沒必要填寫。 |
timestamp |
是 |
時間戳,商戶生成從1970年1月1日00:00:00至今的秒數,即當前的時間,且最終須要轉換爲字符串形式; 由商戶生成後傳入。 |
signature |
是 |
簽名,商戶將接口列表中的參數按照指定方式進行簽名,簽名方式使用SHA1,具體簽名方案參見下文;由商戶按照規範簽名後傳入。 |
balance |
否 |
紅包餘額,以分爲單位。紅包類型必填(LUCKY_MONEY),其餘卡券類型不填。 |
簽名說明
卡券簽名cardSign說明
附錄7-常見錯誤及解決方法
調用config 接口的時候傳入參數 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進行緩存以確保不會觸發頻率限制。
附錄9-問題反饋
郵箱地址:weixin-open@qq.com
郵件主題:【微信JS-SDK反饋】
郵件內容說明:
用簡明的語言描述問題所在,並交代清楚遇到該問題的場景,可附上截屏圖片,微信團隊會盡快處理你的反饋。