接口参数

API描述

API 名称

获取推广链接接口

API 描述

支持获取活动物料、到店/到家/买菜业务类型的推广链接;支持按活动物料ID、商品券展示ID、目标链接的形式获取对应的推广链接;支持appkey-sid两级渠道追踪推广效果。需要用POST方法调用接口。

API地址

https://media.meituan.com/cps_open/common/api/v1/get_referral_link

入参

 

  1. 公共签名请求头

    参数名称

    类型

    是否必填

    描述

    公共签名请求头

    -

    必填

    公共请求签名参数

    S-Ca-App

    String

    必填

    分配的AppKey

    S-Ca-Signature

    String

    必填

    签名字符串

    S-Ca-Timestamp

    String

    必填

    API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为2分钟

    Content-MD5

    String

    非必填

    Body MD5,有请求体接口必传

    S-Ca-Signature-Headers

    String

    非必填

    将需要签名的header,使用英文逗号分割放到 Request 的 Header 中,其中必须包括S-Ca-Timestamp,建议将S-Ca-App也添加进去,例如【S-Ca-Timestamp,S-Ca-App】
  2. 接口请求body

    参数名称

    类型

    是否必填

    描述

    接口请求body

    -

    必填

    接口请求body内容,JSON结构

    platform Integer 非必填 商品所属业务一级分类类型;请求的商品推广链接所属的业务类型信息,即只有输入skuViewId时才需要传本字段:1 到家及其他业务类型,2 到店业务类型;不填则默认1
    bizLine Integer 非必填 商品所属业务二级分类类型;请求的商品推广链接所属的业务类型信息,即只有输入skuViewId时才需要传本字段;当字段platform为1,选择到家及其他业务类型时:5 医药,不填则默认null,表示外卖商品券;当字段platform为2,选择到店业务类型时:1 到餐,2 到综 3:酒店 4:门票 不填则默认1

    actId

    String

    非必填

    活动物料ID,我要推广-活动推广中第一列的id信息(和商品id、活动链接三选一填写,不能全填)

    skuViewId

    String

    非必填

    商品id,对商品查询接口返回的skuViewid(和活动物料ID、活动链接三选一,不能全填)

    sid

    String

    非必填

    二级媒体身份标识,用于渠道效果追踪,限制64个字符,仅支持英文、数字和下划线

    linkType

    Integer

    必填

    链接类型,枚举值:1 H5长链接;2 H5短链接;3 deeplink(唤起)链接;4 微信小程序唤起路径;5 团口令

    text

    String

    非必填

    只支持到家外卖商品券、买菜业务类型链接和活动物料链接。活动链接,即想要推广的目标链接,出参会返回成自己可推的链接,限定为当前可推广的活动链接或者商品券链接,请求内容尽量保持在200字以内,文本中仅存在一个http协议头的链接

出参

 

参数名称

类型

是否必填

描述

code

Integer

必填

响应码,0成功,其他失败

message

String

必填

响应文案

data

String

非必填

返回对应的推广链接,这里的链接才能实现跟单计佣

skuViewId

String

非必填

若用text进行入参取链,且返回的推广链接为商品券链接,则返回对应商品的展示ID,可以根据该ID查商品券接口获取对应的展示信息和佣金信息

 

请求示例:

返回示例:

异常示例