跳到主要内容

创建深度链接

最后更新：2023/11/09

接口说明​

使用 HTTPS 请求头添加: Authorization: Bearer $AppKey
此 API 需要： AppKey

调用方式​

对接口传参​

参数解释​

请求包体:

{
    "project_id": "X5c6Zz8CeUcwim82YXteh9",
    "title": "链接标题", 
    "tag_name": ["标签1","标签2"], 
    "unique_mark": "",
    "valid_invite_time": 0,
    "link_data": [
        {
            "key": "couponId",
            "value": "38194"
        },
        {
            "key": "channel",
            "value": "38421"
        }
    ],
    "redirections": {
        "redirect_default": "https://www.turbolink.ai/",
        "redirect_android": "https://play.google.com/store/apps/details?id=com.branchcn.www",
        "redirect_ios": "https://apps.apple.com/cn/app/"
    },
    "download_page": {
        "media_type" : "ImageText",
        "image_text" : [
        {
            "avatar" : "https://dev.branchcn.com/flink/assets/images/flink.svg",
            "nick_name" : "Jeff",
            "title" : "AIGC酷毙了",
            "desc" : "我用AIGC生成了一张图，美美的，大家也来玩一下吧。",
            "image" : "https://img0.baidu.com/it/u=3891311026,3101645143&fm=253&fmt=auto&app=120&f=JPEG?w=658&h=989"
        }
        ]
    },
    "pre_domain": "abc"
}

参数说明:

参数必须类型说明
project_id是string您的 Project ID
title是string链接标题
tag_name否array(string)链接标签
unique_mark否string创建唯一链接标识，以此标识来确定链接的唯一。如传：用户ID，这个用户就只创建唯一的链接了
valid_invite_time否int32链接有效的邀请时间，超过该时间不算在有效的邀请用户中，单位：s, 如生成链接24小时内的才算，这里就是:86400
link_data是array(object)深度链接自定义键值对
link_data.key否string自定义参数键
link_data.value否string自定义参数值
redirections是object跳转配置
redirections.redirect_default否string默认跳转，PC 端跳到这
redirections.redirect_android否stringAndroid 跳转
redirections.redirect_android否stringiOS 跳转
download_page否object动态下载页的内容 效果查看
download_page.media_type否string内容类型：ImageText （图文）
download_page.image_text否array(object)图文内容信息
download_page.image_text.avatar否string用户头像URL
download_page.image_text.nick_name否string用户昵称
download_page.image_text.title否string内容标题
download_page.image_text.desc否string内容描述
download_page.image_text.image否string用户头像
pre_domain否string链接附带域名前缀

返回结果​

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "link_id": "68qfBEW84TQDRmb3wCPowk",
        "link": "https://abc-www.allapp.link/68qfBEW84TQDRmb3wCPowk", 
        "link_code": "¥1lMxt2E9Xd¥"
    }
}

参数说明：

参数类型说明
codeint32操作结果代码， 200 - 成功
msgStringcode 非 200 时为错误信息
dataobj如有数据，则返回
data.link_idString链接Hash ID
data.linkString创建好的链接地址
data.link_codeString口令code