开发手册深度链接API V3创建深度链接

接口说明

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

调用方式

对接口传参

参数解释

请求包体:

{
    "project_id": "X5c6Zz8CeUcwim82YXtsh9",
    "template_id": "1054",
    "title": "链接名称",
    "tag_name": ["标签1"],
    "user_id": "",
    "link_data": [
        {"key": "new_key", "value": "new_value"}
    ],
    "pre_domain": "",
    "redirections": {
        "android": {
            "use_custom": 1,
            "use_land": 1,
            "redirect_type": 2,
            "custom_url": "https://www.turbolink.ai"
        },
        "ios": {
            "use_custom": 1,
            "use_land": 1,
            "redirect_type": 2,
            "custom_url": "https://www.turbolink.ai/1"
        },
        "default": {
            "use_custom": 1,
            "custom_url": "https://www.turbolink.ai/2"
        }
    },
    "share": {
        "title": "社媒标题",
        "desc": "社媒描述",
        "image": "https://img0.xxx.com/1.jpg"
    }
}

参数说明:

参数必须类型说明
project_idstring您的 Project ID
template_idstring您的模板id
titlestring链接标题
tag_namearray(string)链接标签
user_idstring创建唯一链接标识,以此标识来确定链接的唯一。填写后这个用户就只创建唯一的链接了
link_dataarray(object)深度链接自定义键值对
link_data.keystring自定义参数键
link_data.valuestring自定义参数值
pre_domainstring链接附带域名前缀
redirectionsobject跳转配置
redirections.androidobject安卓跳转配置
redirections.android.use_customint32是否使用自定义配置(0-否 1-是)
redirections.android.use_landint32当use_custom=1时使用,链接是否跳转到落地页(0-否 1-是)
redirections.android.redirect_typeint32当use_custom=1时使用,跳转方式(1-GooglePlay商店 2-自定义网址)
redirections.android.custom_urlstringredirect_type=2时使用,自定义网址
redirections.iosobjectios跳转配置
redirections.ios.use_customint32是否使用自定义配置(0-否 1-是)
redirections.ios.use_landint32当use_custom=1时使用,链接是否跳转到落地页(0-否 1-是)
redirections.ios.redirect_typeint32当use_custom=1时使用,跳转方式(1-AppStore 2-自定义网址)
redirections.ios.custom_urlstringredirect_type=2时使用,自定义网址
redirections.defaultobject默认跳转配置
redirections.default.use_customint32是否使用自定义配置(0-否 1-是)
redirections.default.custom_urlstring当use_custom=1时使用,自定义默认跳转地址
shareobject社媒分享配置
share.titlestring社媒分享标题
share.descstring社媒分享描述
share.imagestring社媒分享缩略图

返回结果

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "link_template": "1054",
        "short_hash": "47kihy",
        "link_url": "https://test.allapp.link/1054/47kihy"
    }
}

参数说明:

参数类型说明
codeint32操作结果代码, 200 - 成功
msgStringcode 非 200 时为错误信息
dataobj如有数据,则返回
data.link_templateString链接模板id
data.short_hashString链接短链hash
data.link_urlString完整链接地址