文档中心 > 追踪短链 > iOS SDK集成指南

iOS SDK集成指南

一、SDK说明

适用版本

本文档适用于短链SDK v1.0.0及以后版本。

二、创建应用

在官网创建创建应用，创建成功后自动生成appid标记该应用。

三、创建短链

登录官网进入开发者平台，选择【追踪短链】-【短链管理】-【创建短链】。
1628763478(1).png

3.1App创建应用

1628763666(1).png
依照指示填写相关内容即可，短链投放渠道可以选择上海璟梦信息科技有限公司、自有平台。

3.2小程序创建应用

1628763827(1).png
依照指示填写相关内容即可，短链投放渠道可以选择上海璟梦信息科技有限公司、自有平台。

小程序跳转地址获取方法如下：

（1）登录小程序后台；
（2）选择右上角【工具】；
1628763951(1).png
（3）根据页面提示填写相关内容后即可获取。

3.3集成模板页

在创建短链时，可以选择使用自己的下载页，在此之前需要为下载页完成 Web集成。
1628764235(1).png
将以上段代码嵌入到短链落地页（即用户点击短链跳转的目标页面）body标签之前即可。
也可以使用使用千帆互动提供的模板页，需要在模板页进行编辑。
1628764338(1).png

四、配置工程

4.1导入SDK

4.1.1 手动导入

在官网下载最新SDK
解压后，将framework文件夹拖入项目中（请勾选 “Copy items if needed” )。

4.2 项目配置

4.2.1 配置APPID

在苹果官网注册 appid 时需要勾选Associated Domains ，如图：

4.2.1 配置 URL Scheme

在 Xcode>Target>Info->URL Types中填写控制台设置的 Scheme，xcode 中必须和控制台填写的一致。如下图

4.2.2 配置通用链接（universal link）

在Xcode>Target>Signing&Capablities中添加Associated Domains ，如下图：

然后将控制台生成的域名填入项目中如下：此处以 1rQM1d.new253.com 为例

注意

必须把指的的所有的universal link域名都填入配置中，记得加前缀：applinks:

五、SDK 调用

导入SDK头文件
#import <CLLink/CLLink.h>

5.1 初始化SDK

在APP的启动方法中 application:didFinishLaunchingWithOptions: 调用依赖的基础模块中的registerAppId:进行初始化。代码如下

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.

    v1.0.0.0版本：
    [CLCoreManager initWithAppid:@"appid"];
    
    
    v1.0.0.1及以后版本：
    [CLCoreManager initWithAppkey:@"appkey"];
   
    return YES;
}

5.2 配置一键拉起功能

在app已安装的情况下，从各平台、浏览器拉起时传递参数。

-(BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation{
    
    [CLLinkManager wakeUpLink:url];
    //其他第三方回调；
    return YES;
}
//iOS9以上
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(nonnull NSDictionary *)options{
    
    [CLLinkManager wakeUpLink:url];
    //其他第三方回调；
     return YES;
}

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler{
    
    [CLLinkManager continueUserActivity:userActivity];
    //其他第三方回调；
     return YES;
}

5.3 场景还原

在 app 被唤醒时，从各平台、各种浏览器点击短链唤醒APP，当在有效时间内点击打开 app 时获取设置的参数。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.
    
    //初始化
    ...
    
    //注册唤醒回调
    [CLLinkManager registerWakeUpCallBack:^(CLLinkResponse * _Nonnull linkResponse) {
        
        //跳转处理
        
    }];

    return YES;
}

5.4 获取无码邀请参数

场景中免除填写邀请码，规避用户操作繁琐而带来的影响，提高转化率。如：APP 需要安装参数/游戏间邀请好友/地推活动/建立上下级关系，快速安装打开应用完成业务的奖励.

//无码邀请参数
[CLLinkManager getInvitationParams:nil result:^(NSDictionary * _Nonnull parmas) {
        
        //根据返回参数完成邀请、绑定等逻辑
 }];

开发者中心