Web集成指南
特别提醒:js文件会不定期更新,请勿下载保存到本地使用,否则会导致安装参数匹配不成功
一、集成Sharetrace js SDK
方式一:直接引入
<script src="https://res.sharetrace.com/sharetrace.min.js"></script>
<script>
// 请填入对应的 App Key
ShareTrace.init('your_app_key');
// 请在用户点击下载按钮时,触发此函数
function download() {
ShareTrace.download();
}
</script>
方式二:在VUE中引入
在 public/index.html
添加依赖
<html>
<head>
...
<script src="https://res.sharetrace.com/sharetrace.min.js"></script>
...
</head>
<body>
...
</body>
</html>
在下载页初始化
export default {
...
created() {
...
// 请填入对应的 App Key
ShareTrace.init('SHARETRACE_APPKEY');
...
},
methods: {
...
handleDownload() {
// 请在用户点击下载按钮时,触发此函数
ShareTrace.download();
}
...
}
}
提醒:ShareTrace.download();函数调用的下载方式, 必须在ShareTrace控制台里配置,有自定义链接地址、应用市场、平台托管三种安装方式,任选一种即可。(安装方式配置页面:控制台 — 应用详情 — Android/iOS配置 — 应用配置)
二、Sharetrace js SDK 一键调起配置
Sharetrace支持通过标准的Scheme和Universal Links(iOS>=9),接入Sharetrace SDK后,在各种浏览器,包括微信,微博等内置浏览器一键调起app,并传递网页配置等自定义动态参数。简单步骤如下:
- 先到Sharetrace后台,分别打开Android和iOS配置中的Scheme开关,对于iOS建议也打开Universal Links(iOS>=9)开关
- 参照客户端配置文档分配配置Android和iOS的一键调起
- 目前Sharetrace的默认下载页已经支持一键调起,如果自定义下载页,引入Sharetrace js 后,请在用户点击下载按钮时,触发此函数:
ShareTrace.download();// 如果已经安装会尝试调起,未安装则触发下载
三、接口补充说明
3.1 ShareTrace.init
有两种初始化方式。
3.1.1 精简配置
ShareTrace.init("SHARETRACE_APPKEY")
3.1.2 更多配置
【参数名】 | 【参数类型】 | 【是否必填】 | 【参数说明】 |
---|---|---|---|
appkey | string | 必填 |
应用的AppKey,可到控制台中查看 |
param | string | 选填 | 分享参数,如果不填写,默认取url的参数(url ? 后面的参数) |
error | function(errMsg) | 选填 | 监听初始化异常 |
success | function() | 选填 | 监听初始化成功 |
例子:
ShareTrace.init({
appkey: "your_app_key", // 此值必填
param: "myKey=myValue",
success: function() {
console.log("init success...")
},
error: function(msg) {
console.log(msg)
}
});
3.2 ShareTrace.preDownload
自定义重定向
如果要自定义下载方式,自己根据设备环境进行下载链接的重定向,可以在进行重定向之前调用ShareTrace.preDownload
,不要再调用ShareTrace.download
方法,download
方法内部会根据在控制台配置的安装方式自动进行重定向。
如果重定向的是网页而不是下载地址,建议在回调中进行重定向。示例代码:
ShareTrace.preDownload(function () {
window.location.href = 'YOUR REDIRECT PAGE';
});
四、完整的示例代码
<script src="https://res.sharetrace.com/sharetrace.min.js"></script>
<script>
let isInitSuccess = false;
ShareTrace.init({
appkey: 'YOUR APP KEY', //分配的appkey
param: 'CUSTOM PARAMS', //自定义参数,如果不设置默认会取url携带的参数
success: function () {
isInitSuccess = true;
/*
如果开启调起app功能建议在此处调用wakeUp()
*/
//ShareTrace.wakeUp();
/*
如果要打开页面就自动下载,建议在此处调用download()方法,
不过此处调用可能会降低成功率,建议在点击方法中触发download()方法
*/
//ShareTrace.download();
}
});
//下载按钮点击时调用方法
function btnClick(){
if(isInitSuccess){
ShareTrace.download();
}else{
//如果初始化失败建议自己指定下载地址,虽然不能获取安装参数但是不会影响用户的下载
window.location.href = 'YOUR DOWNLOAD URL';
}
}
</script>