淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
file_preview_url_list	GetFilePreviewUrl	必须			获取文件预览url请求列表对象
└ file_token String 可选 wda984f89e4f98aw 文件token └ buyer_open_id String 必须 wd46a4f86qa4f861aw6f 买家openId └ order_id String 可选 22561*************11 订单id

名称	类型	示例值	描述
get_file_preview_result_list	GetFilePreviewResult []		getFilePreviewResultList
└ file_url_expiration String 2024-12-10T11:44:32Z fileUrlExpiration └ error_message String fileToken and orderId cannot be empty at the same time errorMessage └ file_url String http://oss-cn-hangzhou.aliyuncs.com/appkey-123456/miniappId-3005111616/wadafwafafaf 文件路径 └ status Boolean false 本条状态

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpentradeCustomizationFileGetRequest req = new OpentradeCustomizationFileGetRequest();
OpentradeCustomizationFileGetRequest.GetFilePreviewUrl obj1 = new OpentradeCustomizationFileGetRequest.GetFilePreviewUrl();
obj1.setFileToken("wda984f89e4f98aw");
obj1.setBuyerOpenId("wd46a4f86qa4f861aw6f");
obj1.setOrderId("22561*************11");
req.setFilePreviewUrlList(obj1);
OpentradeCustomizationFileGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpentradeCustomizationFileGetRequest req = new OpentradeCustomizationFileGetRequest();
OpentradeCustomizationFileGetRequest.GetFilePreviewUrlDomain obj1 = new OpentradeCustomizationFileGetRequest.GetFilePreviewUrlDomain();
obj1.FileToken = "wda984f89e4f98aw";
obj1.BuyerOpenId = "wd46a4f86qa4f861aw6f";
obj1.OrderId = "22561*************11";
req.FilePreviewUrlList_ = obj1;
OpentradeCustomizationFileGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpentradeCustomizationFileGetRequest;
$file_preview_url_list = new GetFilePreviewUrl;
$file_preview_url_list->file_token="wda984f89e4f98aw";
$file_preview_url_list->buyer_open_id="wd46a4f86qa4f861aw6f";
$file_preview_url_list->order_id="22561*************11";
$req->setFilePreviewUrlList(json_encode($file_preview_url_list));
$resp = $c->execute($req, $sessionKey);

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=taobao.opentrade.customization.file.get' \
-d 'partner_id=apidoc' \
-d 'session=5ab18b7d-358d-4f66-8c6f-51d90f28f020' \
-d 'sign=9D63E361B8AE59F360E667740E683BAC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-03-05+10%3A16%3A39' \
-d 'v=2.0' \
-d 'file_preview_url_list=null'

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

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

req.file_preview_url_list="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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,"taobao.opentrade.customization.file.get");
add_param(pRequest,"file_preview_url_list","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('taobao.opentrade.customization.file.get', {
	'file_preview_url_list':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opentrade_customization_file_get_response>
    <get_file_preview_result_list>
        <get_file_preview_result>
            <file_url_expiration>2024-12-10T11:44:32Z</file_url_expiration>
            <error_message>fileToken and orderId cannot be empty at the same time</error_message>
            <file_url>http://oss-cn-hangzhou.aliyuncs.com/appkey-123456/miniappId-3005111616/wadafwafafaf</file_url>
            <status>false</status>
        </get_file_preview_result>
    </get_file_preview_result_list>
</opentrade_customization_file_get_response>

{
    "opentrade_customization_file_get_response":{
        "get_file_preview_result_list":{
            "get_file_preview_result":[
                {
                    "file_url_expiration":"2024-12-10T11:44:32Z",
                    "error_message":"fileToken and orderId cannot be empty at the same time",
                    "file_url":"http:\/\/oss-cn-hangzhou.aliyuncs.com\/appkey-123456\/miniappId-3005111616\/wadafwafafaf",
                    "status":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

taobao.opentrade.customization.file.get (根据token获取文件的地址（预览/下载）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ