JS-SDK说明⽂档
概述
JS-SDK是公众平台 ⾯向⽹页开发者提供的基于内的⽹页开发⼯具包。
通过使⽤JS-SDK,⽹页开发者可借助⾼效地使⽤拍照、选图、语⾳、位置等⼿机系统的能⼒,同时可以直接使⽤分享、扫⼀扫、卡券、⽀付等特有的能⼒,为⽤户提供更优质的⽹页体验。
此⽂档⾯向⽹页开发者介绍JS-SDK如何使⽤及相关注意事项。
JSSDK使⽤步骤
步骤⼀:绑定域名
先登录公众平台进⼊“设置”的“功能设置”⾥填写“JS接⼝安全域名”。
备注:登录后可在“开发者中⼼”查看对应的接⼝权限。
步骤⼆:引⼊JS⽂件
备注:⽀持使⽤ AMD/CMD 标准模块加载⽅法加载
步骤三:通过config接⼝注⼊权限验证配置
所有需要使⽤JS-SDK的页⾯必须先注⼊配置信息,否则将⽆法调⽤(同⼀个url仅需调⽤⼀次,对于变化url的SPA的web app可在每次url 变化时进⾏调⽤,⽬前Android客户端不⽀持pushState的H5新特性,所以使⽤pushState来实现web app的页⾯会导致签名失败,此问题会在Android6.2中修复)。
debug:true,// 开启调试模式,调⽤的所有api的返回值会在客户端alert出来,若要查看传⼊的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
appId:'',// 必填,的唯⼀标识
timestamp:,// 必填,⽣成签名的时间戳
nonceStr:'',// 必填,⽣成签名的随机串
signature:'',// 必填,签名
jsApiList:[]// 必填,需要使⽤的JS接⼝列表
});
签名算法见⽂末的附录1,所有JS接⼝列表见⽂末的附录2
注意:如果使⽤的是⼩程序云开发静态⽹站托管的域名的⽹页,可以免鉴权直接跳任意合法合规⼩程序,调⽤ wx.config 时 appId 需填⼊⾮个⼈主体的已认证⼩程序,不需计算签名,timestamp、nonceStr、signature 填⼊⾮空任意值即可。
步骤四:通过ready接⼝处理成功验证
// config信息验证后会执⾏ready⽅法,所有接⼝调⽤都必须在config接⼝获得结果之后,config是⼀个客户端的异步操作,所以如果需要在页⾯加载时就调⽤相关接⼝,则须把相关接⼝放在ready函数中调⽤来确保正确执⾏。对于⽤户触发时才调⽤的接⼝,则可以直接调⽤,不需要放在ready函数中。
});
步骤五:通过error接⼝处理失败验证
<(function(res){
// config信息验证失败会执⾏error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SP A可以在这⾥更新签名。
});
接⼝调⽤说明
所有接⼝通过wx对象(也可使⽤jWeixin对象)来调⽤,参数是⼀个对象,除了每个接⼝本⾝需要传的参数之外,还有以下通⽤参数:
success:接⼝调⽤成功时执⾏的回调函数。
fail:接⼝调⽤失败时执⾏的回调函数。
complete:接⼝调⽤完成时执⾏的回调函数,⽆论成功或失败都会执⾏。
cancel:⽤户点击取消时的回调函数,仅部分有⽤户取消操作的api才会⽤到。
trigger: 监听Menu中的按钮点击时触发的⽅法,该⽅法仅⽀持Menu中的相关接⼝。
备注:不要尝试在trigger中使⽤ajax异步请求修改本次分享的内容,因为客户端分享操作是⼀个同步操作,这时候使⽤ajax的回包会还没有返回。
以上⼏个函数都带有⼀个参数,类型为对象,其中除了每个接⼝本⾝返回的数据之外,还有⼀个通⽤属性errMsg,其值格式如下:
调⽤成功时:“xxx:ok” ,其中xxx为调⽤的接⼝名
⽤户取消时:“xxx:cancel”,其中xxx为调⽤的接⼝名
调⽤失败时:其值为具体错误信息
>>> <<<
模拟JSSDK权限校验
在调试器中打开该 URL,可以⽅便地在右侧的 JS-SDK Tab 中看到当前页⾯ wx.config 的校验情况和 JSSDK 的调⽤ log。 如下是校验通过的页⾯:
在控制台⾥会显⽰当前页⾯拥有权限的 JS-SDK 列表。
如下是校验未通过的页⾯:
javascript说明
结合左侧的 Webview 模拟器,可以直观地调试 JSSDK 的效果,能够在console栏⾥看到调⽤的API的结果。
注意:0.7.0 及以后版本的 web 开发者⼯具⽀持卡券 JSSDK 的调试,但对于希望调试的卡券,我们要求开发者号与之建⽴绑定关系,绑定流程同授权登录⼀致。
URL收藏与⼆维码预览
为了⽅便开发者快速打开要调试的⽹页,开发者⼯具有两个⽅便的⼩功能:
URL收藏
类似浏览器⾥的书签功能,你可以把你经常需要调试的⽹页通过点击URL地址栏上的星星的icon将其收藏。
收藏之后你可以在收藏夹⾥看到所收藏的URL:
取消收藏也很简单,在已经收藏的URL的星星上再点击⼀次就可以取消收藏。
⼆维码预览
为了⽅便开发者快速通过⼿机打开⽹页预览效果,可以通过点击「预览」按钮给出当前⽹页的⼆维码:
移动调试
注意:移动调试仅⽀持0.5.0 - 0.7.0版本的开发者⼯具。1.x版本的开发者⼯具不⽀持此功能!
移动端⽹页的表现,通常和桌⾯浏览器上有所区别,包括样式的呈现、脚本的逻辑等等,这会给开发者带来⼀定的困扰。现在,安卓客户端 webview 已经开始全⾯升级⾄ X5 Blink 内核,新的内核⽆论在渲染能⼒、API ⽀持还是在开发辅助上都有很⼤进步。通过 web 开发者⼯具中的远程调试功能,实时映射⼿机屏幕到 web 开发者⼯具上,将帮助开发者更⾼效地调试 X5 Blink 内核的⽹页,具体步骤如下:
(1)准备⼯作
安装0.5.0或以上版本的 web 开发者⼯具
确认移动设备是否⽀持远程调试功能
打开 web 开发者⼯具,选择“移动调试”tab,点击验证移动设备是否⽀持。随后使⽤移动设备扫描弹出的⼆维码,在设备上即可获得⽀持信息。
打开移动设备中的 USB 调试功能
1.打开移动设备,进⼊“设置”->“开发⼈员选项”
2.勾选“USB 调试功能”
需要注意的是,Android 4.2 之后的设备,开发⼈员选项默认是隐藏的,通过以下步骤可以打开:
1.打开移动设备,进⼊“设置”->“关于⼿机”
2.到并单击“内部版本号”7次
打开 X5 Blink 内核的 inspector 功能
打开 web 开发者⼯具,选择“移动调试”tab ,使⽤设备扫描“调试步骤”中的⼆维码。
如下图,勾选“是否打开 TBS 内核 Inspector 调试功能”,并重启。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论