3. WEB 集成
shareinstall 提供完整的 javascript api,方便 Web 开发者实现完全自主的设计 集成步骤:
1、推广页中引用 jshareinstall.min.js 文件
特别提示:请直接使用此链接,不要将此链接下载到您项目中,否则,在更新数据接口或 API 的时候可能会导致链接失效。
<script type="text/javascript" src="//www.shareinstall.com.cn/js/page/jshareinstall.min.js"></script>
2、在 HTML 页面中增加一个或者多个打开 app 的元素标签
一般开发者会使用 CSS 样式重置这个链接的外观,使其看起来像一个按钮,建议使用“打开 APP”、“在 APP 中购买”、“在 APP 中阅读”等对用户有实际引导意义的文案,请尽量避免使用“下载 APP”,在以往的用户使用习惯中我们发现使用“下载 APP”的链接对比使用“打开 APP”的链接的点击率会低。
<a href="javascript:void(0);" id="downloadButton"></a>
3、在 H5 页面中动态传参
在集成页面的地址后面以 key=value 的形式进行拼接参数进行传参。如果参数过长,建议使用在 url 后面传 id,在页面中通过 id 值来获取参数,并把参数加入初始化 Shareinstall 的 data 对象中,可以 URL 更加优雅简洁。
4、参数说明
<script type="text/javascript">
// shareinstall初始化,初始化时将与shareinstall服务器交互,应尽可能早的调用
/* web页面向app传递的json数据(json string/js Object),应用被拉起或是首次安装时,通过相应的android/ios api可以获取此数据 */
var data = ShareInstall.parseUrlParams(); // shareinstall.js中提供的工具函数,解析url中的所有查询参数
new ShareInstall({
appKey: 'shareinstall为当前应用分配的appkey',
// 可选项,微信中自定义的遮罩层
// shadow : function(){
// return "<div id='shareinstall_shadow' style='position:fixed;left:0;top:0;background:rgba(0,255,0,0.5);filter:alpha(opacity=50);width:100%;height:100%;z-index:10000;'></div>"
// },
// 可选参数,是否优先考虑拉起app,以牺牲下载体验为代价 默认true
// preferWakeup: true,
// 可选参数,唤醒操作的执行时长,超时后将放弃唤醒并执行下载,默认1500,单位是毫秒
// timeout: 1500,
onready : function() {
// shareinstall已成功回调
var m = this, button = document.getElementById("downloadButton");
button.style.visibility = "visible";
// 用户点击某个按钮时(假定按钮id为downloadButton),安装app
button.onclick = function() {
m.wakeupOrInstall();
}
}
}, data);
</script>