Web 接入指南

1. 创建应用

登录控制台 -> 应用列表 -> 创建应用

☝️注意:️iOS、Android、Web三种平台只需在控制台创建一个应用即可。

2. 接入SDK

    <script src="https://static.tracksdk.com/sdk/js/1.0.0/tracksdk.js"></script>

3. 初始化 TrackSDK

直接调用initTrackSDK(options)方法即可

options 参数属性说明
属性 类型 必选 说明
dev boolean 是否是开发环境,对应控制台的环境设置,默认为 false
appId string 应用ID,可登陆控制台查看
channelId string 渠道ID,可登陆控制台查看【控制台->管理->渠道管理】(渠道ID和绑定数据至少传一个)
data string 自定义绑定数据(渠道ID和绑定数据至少传一个)
attachTo string id 选择器,用于SDK查找到下载按钮,并监听点击事件进行应用下载,例如:#down-btn
failback object 故障备用下载地址设置,{ipa:"iOS应用下载页地址",apk:"Android应用APK文件下载地址"} 当SDK正在初始化或者初始化失败,此时点击下载按钮则使用该备用地址进行下载
shouldDownload function 用于判断当前浏览是否允许直接下载文件,需要方法返回一个布尔值,不设置该参数时默认当前SDK只对微信和支付宝做了判断,如果开发者需要判断更多浏览器,请设置该方法覆盖SDK的默认判断结果
onMaskLayerShow function 当前浏览器不可直接下载应用时,SDK会回调该方法方便开发者自定义显示提示层,不设置时,会显示SDK默认的提示层(看下图)
onSuccess function 初始化成功回调
onError function 初始化失败回调

浏览器无法下载文件时的默认提示层,例如:微信内打开的网页是不允许直接下载文件的

initTrackSDK 方法调用示例
    initTrackSDK({
        dev: false,
        appId: '应用ID',
        channelId: '渠道ID',
        data: 'hello world',
        attachTo: '#down-btn',
        failback: {
            ipa: 'https://itunes.apple.com/cn/app/xxx/idxxxxx',
            apk: 'http://static.tracksdk.com/apk/xxxx.apk'
        },
        onMaskLayerShow: function(){
            alert('请使用浏览器打开');
        },
        shouldDownload: function(userAgent){
            //判断当前浏览器是否允许下载
            if(/MicroMessenger|AlipayClient/i.test(userAgent)){
                return false;
            }
            return true;
        },
        onSuccess: function () {
            //初始化成功
        },
        onError: function (err) {
            //初始化失败
        },
    })

results matching ""

    No results matching ""