APICloud接入

一、创建应用

注册/登录 sharetrace控制台 并创建应用。

二、导入模块

sharetrace 官方模块已上架到 APICloud 模块Store。可前往APICloud获取模块 按照 APICloud 官方文档添加模块。

三、配置

使用本模块需要到 sharetrace 申请 sharetrace 的开发者账号并创建应用并获取到appKey。 使用此模块之前需先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:

名称:sharetrace

参数:com.sharetrace.APP_KEY

配置示例:

  <feature name="sharetrace">
    <param name="com.sharetrace.APP_KEY" value="sharetrace分配的appKey"/>
  </feature>

字段描述: com.sharetrace.APP_KEY:(必须配置)在 sharetrace 开放平台创建应用后,该平台会为每个应用分配一个appKey。

如果开启了独立IP服务,还需要在此处配置 sharetrace 为你分配的独立域名。

参数:com.sharetrace.SERVER_DOMAIN

配置示例:

  <feature name="sharetrace">
    <param name="com.sharetrace.APP_KEY" value="sharetrace分配的appKey"/>
    <param name="com.sharetrace.SERVER_DOMAIN" value="sharetrace分配的SERVER_DOMAIN"/>
  </feature>

注意: 如果未开启独立IP服务,请勿配置该参数

四、获取参数

模块导入后,在需要获取安装参数的页面调用getInstallTrace方法即可获取到携带的参数,代码示例:

var sharetrace = api.require('sharetrace');
sharetrace.getInstallTrace(function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

返回值ret:

类型:JSON 对象

内部字段:

{
    code: 200, //结果码,200为请求成功,其他均为失败
    msg: 'success',  //结果信息
    data: {
        paramsData:'',  //字符串类型;安装携带的参数
        channel:''      //字符串类型;渠道
    }
}

五、获取一键调起参数

Sharetrace支持通过标准的Scheme和Universal Links(iOS>=9),接入Sharetrace SDK后,在各种浏览器,包括微信,微博等内置浏览器一键调起app,并传递网页配置等自定义动态参数。配置只需简单几个步骤即可,如下:

5.1 开启一键调起功能

登录Sharetrace的管理后台,找到iOS配置,开启相关功能和填入配置

5_apple_config_on.png

其中Team Id可以在Apple开发者后台查看; 同理,找到Sharetrace后台的Android配置,开启相关功能。

5.2 开启Associated Domains服务

登录到Apple管理后台,在Identifiers找到所需开启到App ID

5_apple_dev_config.png

注: 更新这个开关后,参考APICloud文档, 更新相应的mobileprovision证书, 否则iOS的Universal Link 无法正常使用。

5.3 应用相关配置

  1. 配置关联域名(Associated Domains),方法如下:

在widget\res下创建文件名为UZApp.entitlements的文件,UZApp.entitlements内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>com.apple.developer.associated-domains</key>
        <array>
            <string>applinks:[填入Sharetrace分配的applinks].stul.sharetrace.com</string>
        </array>
    </dict>
</plist>

其他问题可以参考【官方】通用链接(Universal Links)实现

  1. 配置Scheme

找到config.xml 文件, 填入如下内容:

<preference  name="urlScheme"  value="[填入Sharetrace分配的Scheme]"  />

5.4 接口使用

<script type="text/javascript">
    apiready = function() {
        api.addEventListener({
            name:'appintent'
        }, function(ret, err) {
            getWakeupTrace(ret);
        });
    };

    function getWakeupTrace(intentRet) {
        var sharetrace = api.require("sharetrace");
        sharetrace.getWakeupTrace(intentRet, function(ret, err) {
            alert(JSON.stringify(ret));
        });
    }
</script>

返回值ret:

类型:JSON 对象

内部字段:

{
    code: 200, //结果码,200为请求成功,其他均为失败
    msg: 'success',  //结果信息
    data: {
        paramsData:'',  //字符串类型;安装携带的参数
        channel:''      //字符串类型;渠道
    }
}

六、配置安装方式

SDK 集成完成后,按照sharetrace控制台接入流程完成后续的配置。

results matching ""

    No results matching ""