阿里安全开放平台-阿里聚安全

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
user_id	Number	必须	2234123	小件员id
qr_code_preview_type	String	必须	Personal	可选值为Personal,Merchant
session_code	String	可选	23423asdas	session_code
merchant_id	Number	可选	123	当预览类型为Merchant时，必传字段
personal_user_id	Number	可选	333	个人userid

名称	类型	示例值	描述
data	YmqrCodePreviewDto		data
└ bottom_desc String 底部描述 └ company_name String 企业公司名称 └ logo_image_url String logo图片地址 └ mobile_phone String 小件员电话 └ qrcode_content String 二维码内容 └ top_desc String 顶部描述 └ top_title String 顶部标题 └ user_name String 小件员名称 └ banner_image_url String banner图片地址 └ merchant_name String 自定义商户名称 └ merchant_image_url String 自定义商户图片地址
status_code	String	2	statusCode
status_message	String		statusMessage
is_success	Boolean	false	success

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaPreviewqrPreviewconfigRequest req = new CainiaoYimaPreviewqrPreviewconfigRequest();
req.setUserId(2234123L);
req.setQrCodePreviewType("Personal");
req.setSessionCode("23423asdas");
req.setMerchantId(123L);
req.setPersonalUserId(333L);
CainiaoYimaPreviewqrPreviewconfigResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoYimaPreviewqrPreviewconfigRequest req = new CainiaoYimaPreviewqrPreviewconfigRequest();
req.UserId = 2234123L;
req.QrCodePreviewType = "Personal";
req.SessionCode = "23423asdas";
req.MerchantId = 123L;
req.PersonalUserId = 333L;
CainiaoYimaPreviewqrPreviewconfigResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoYimaPreviewqrPreviewconfigRequest;
$req->setUserId("2234123");
$req->setQrCodePreviewType("Personal");
$req->setSessionCode("23423asdas");
$req->setMerchantId("123");
$req->setPersonalUserId("333");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=cainiao.yima.previewqr.previewconfig' \
-d 'partner_id=apidoc' \
-d 'sign=BA536992EEEA555EDF16518874794FF2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A44%3A57' \
-d 'v=2.0' \
-d 'merchant_id=123' \
-d 'personal_user_id=333' \
-d 'qr_code_preview_type=Personal' \
-d 'session_code=23423asdas' \
-d 'user_id=2234123'

# -*- coding: utf-8 -*-
import top.api

req=top.api.CainiaoYimaPreviewqrPreviewconfigRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.user_id=2234123
req.qr_code_preview_type="Personal"
req.session_code="23423asdas"
req.merchant_id=123
req.personal_user_id=333
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"cainiao.yima.previewqr.previewconfig");
add_param(pRequest,"user_id","2234123");
add_param(pRequest,"qr_code_preview_type","Personal");
add_param(pRequest,"session_code","23423asdas");
add_param(pRequest,"merchant_id","123");
add_param(pRequest,"personal_user_id","333");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('cainiao.yima.previewqr.previewconfig', {
	'user_id':'2234123',
	'qr_code_preview_type':'Personal',
	'session_code':'23423asdas',
	'merchant_id':'123',
	'personal_user_id':'333'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_yima_previewqr_previewconfig_response>
    <data>
        <bottom_desc></bottom_desc>
        <company_name></company_name>
        <logo_image_url></logo_image_url>
        <mobile_phone></mobile_phone>
        <qrcode_content></qrcode_content>
        <top_desc></top_desc>
        <top_title></top_title>
        <user_name></user_name>
        <banner_image_url></banner_image_url>
        <merchant_name></merchant_name>
        <merchant_image_url></merchant_image_url>
    </data>
    <status_code>2</status_code>
    <status_message></status_message>
    <is_success>false</is_success>
</cainiao_yima_previewqr_previewconfig_response>

{
    "cainiao_yima_previewqr_previewconfig_response":{
        "data":{
            "bottom_desc":"",
            "company_name":"",
            "logo_image_url":"",
            "mobile_phone":"",
            "qrcode_content":"",
            "top_desc":"",
            "top_title":"",
            "user_name":"",
            "banner_image_url":"",
            "merchant_name":"",
            "merchant_image_url":""
        },
        "status_code":"2",
        "status_message":"",
        "is_success":false
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

物流API

cainiao.yima.previewqr.previewconfig (获取商家码寄件码预览配置)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈