JS-SDK的使用步骤如下。
步骤1:绑定域名。
使用JS接口需要设置JS接口安全域名,设置后该域名下的页面才有权限调用JS接口。
登录微信公众平台后台,在“公众号设置”|“功能设置”|“JS接口安全域名”中填写域名,如图14-1所示。
图14-1 JS接口安全域名
步骤2:引入JS。
在需要调用JS接口的页面引入JS文件。引入代码如下。
<script src="https:// res.wx.qq.com/open/js/jweixin-1.1.0.js"></script>
步骤3:通过config接口注入权限验证配置。
wx.config({ debug: true, // 开启调试模式,调用的所有API的返回值会在客户端alert出来,若要查看传入 // 的参数,可以在PC端打开,参数信息会通过log打出,仅在PC端时才会打印。 appId: '', // 必填,公众号的唯一标识 timestamp: , // 必填,生成签名的时间戳 nonceStr: '', // 必填,生成签名的随机字符串 signature: '', // 必填,签名 jsApiList: // 必填,需要使用的JS接口列表});
步骤4:通过ready接口处理成功验证。
wx.ready(function{ // config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后。config是一 // 个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则需把相关接口放在ready函数中 // 调用,以确保正确执行。对于用户触发时才调用的接口,则可以直接调用,无须放在ready函数中。});
步骤5:通过error接口处理失败验证。
wx.error(function(res){ // config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的 // debug模式查看,也可以在返回的res参数中查看。对于SPA,可以在这里更新签名。});
步骤6:接口调用。
所有接口通过wx对象(也可使用jWeixin对象)来调用,参数是一个对象,除了每个接口本身需要传的参数之外,还有以下通用参数。
1)success:接口调用成功时执行的回调函数。
2)fail:接口调用失败时执行的回调函数。
3)complete:接口调用完成时执行的回调函数,无论成功或失败都会执行。
4)cancel:用户点击取消时的回调函数,仅部分有用户取消操作的API才会用到。
5)trigger:监听Menu中的按钮点击时触发的方法,该方法仅支持Menu中的相关接口。
以上函数都带有一个参数,类型为对象,其中除了每个接口本身返回的数据之外,还有一个通用属性errMsg,其值的格式如下。
1)调用成功时:"xxx:ok"。其中,xxx为调用的接口名。
2)用户取消时:"xxx:cancel"。其中,xxx为调用的接口名。
3)调用失败时:其值为具体的错误信息。