alipay.open.public.shortlink.create(服务窗短链自主生成接口) 在线调试(沙箱环境)

商户通过本接口生成带自有场景标识的短链接

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.shortlink.create
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
scene_id String 必选 32 短链接对应的场景ID,该ID由商户自己定义 store_pay_01
remark String 可选 256 对于场景ID的描述,商户自己定义 门店1支付推广

响应参数

参数 类型 是否必填 最大长度 描述 示例值
shortlink String 必填 100 生成的带参推广短链接 http://t.alipay.com/I/Ev62jVRm

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicShortlinkCreateRequest request = new AlipayOpenPublicShortlinkCreateRequest();
request.setBizContent("{" +
"\"scene_id\":\"store_pay_01\"," +
"\"remark\":\"门店1支付推广\"" +
"  }");
AlipayOpenPublicShortlinkCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_shortlink_create_response": {
        "code": "10000",
        "msg": "Success",
        "shortlink": "http://t.alipay.com/I/Ev62jVRm"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_open_public_shortlink_create_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
PARSE_XML_JSON_ERROR 解析XML/JSON出错 请检查输入的参数是否有效,否则生成短链时会解析XML/JSON出错
PUBLIC_ID_IS_NULL publicId为空 请检查调用接口时appid是否合法
SCENE_ID_IS_NULL sceneId为空 请输入场景id
INVALID_SCENE_ID 不合法的场景id 请输入合法的场景Id
APP_NOT_EXIST 该服务窗不存在 请输入正确合法的服务窗id
SHORT_LINK_GENERATE_FAIL 短码生成失败 请检查输入参数是否正确
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
onlineServer