如何使用Python调用Branch.io API创建Quick Links快速链接

问题原因 #

• 旧教程提到的type=2标记参数已在接口迭代中废弃，不再生效。
• 你当前调用的https://api2.branch.io/v1/url是公开短链生成接口，默认生成的是普通深度链接，不会同步到后台Quick Links营销列表。
• 抓包拿到的https://dashboard.branch.io/v1/link/marketing是Branch后台的私有接口，仅支持网页端后台登录态鉴权，直接用API Key调用必然返回403，该接口无公开稳定支持，不建议对接。

可落地的官方实现方式 #

通过公开v1/url接口即可生成在Quick Links列表展示的营销链接，只需要补全必要参数、修正标记值即可：

1. 请求体顶层新增branch_secret参数，值为和你的Branch Key配对的接口密钥，可在Branch后台账户设置页获取
2. 将data字段内的核心标记字段~creation_source值从1修改为5，该枚举值是官方定义的「营销Quick Link」来源标记，设置后生成的链接会自动同步到Quick Links列表
3. 修复你现有代码的参数错误：$og_title字段引用了未定义的name变量，会导致参数异常。

修正后的可运行代码 #

import requests
import json

def branch_quick_link(medium, source, campaign, og_title, og_desc, deeplink_path, redirect_url):
    api_url = "https://api2.branch.io/v1/url"
    headers = {'Content-Type': 'application/json'}

    payload = json.dumps({
        "branch_key": "<替换为你的Branch Key>",
        "branch_secret": "<替换为你的Branch Secret>",
        "channel": source,
        "feature": medium,
        "campaign": campaign,
        "data": {
            "$og_title": og_title,
            "$marketing_title": campaign,
            "~creation_source": 5,
            "$og_description": og_desc,
            "~feature": medium,
            "+url": redirect_url,
            "$ios_deeplink_path": deeplink_path,
            "$android_deeplink_path": deeplink_path,
            "~marketing": True,
            "$one_time_use": False,
            "~campaign": campaign,
            "~channel": source
        }
    })

    resp = requests.post(api_url, headers=headers, data=payload)
    print(resp.status_code)
    return resp.json()

注意事项 #

• 接口返回200成功后，等待1~2分钟再到后台Quick Links列表查看，数据同步存在延迟，不会实时展示
• 链接的自定义标签、过期时间、广告平台归因参数等配置，直接在data字段内追加对应控制参数即可，规则和普通深度链接完全一致
• 不要对接dashboard域名下的私有接口，这类接口没有对外服务承诺，参数、鉴权规则随时可能变动，稳定性无保障

内容的提问来源于stack exchange，提问作者Evans Gunawan