淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
open_data_component_query	OpenDataComponentQuery	可选			请求参数
└ scene_code String 必须 OUT_VIP 场景code，淘外入会数据使用OUT_VIP └ biz_id String 必须 1d 业务id。如淘外入会礼，传入不同时间统计周期1d/7d/30d

名称	类型	示例值	描述
model	ComponentInstanceDTO	true	数据模型
└ data_update_time String 2024-05-12 数据更新时间 component_index_data_dto_list ComponentIndexDataDTO [] 数据指标 └ ds String 2024-05-12 数据的时间分区 └ name String cart_uv 指标名称 └ legend String 加购人数：统计时间内，所有会员中有加购的人数指标含义 └ value String 1 指标对应的值

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmComponentDataQueryRequest req = new OpencrmComponentDataQueryRequest();
OpencrmComponentDataQueryRequest.OpenDataComponentQuery obj1 = new OpencrmComponentDataQueryRequest.OpenDataComponentQuery();
obj1.setSceneCode("OUT_VIP");
obj1.setBizId("1d");
req.setOpenDataComponentQuery(obj1);
OpencrmComponentDataQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmComponentDataQueryRequest req = new OpencrmComponentDataQueryRequest();
OpencrmComponentDataQueryRequest.OpenDataComponentQueryDomain obj1 = new OpencrmComponentDataQueryRequest.OpenDataComponentQueryDomain();
obj1.SceneCode = "OUT_VIP";
obj1.BizId = "1d";
req.OpenDataComponentQuery_ = obj1;
OpencrmComponentDataQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmComponentDataQueryRequest;
$open_data_component_query = new OpenDataComponentQuery;
$open_data_component_query->scene_code="OUT_VIP";
$open_data_component_query->biz_id="1d";
$req->setOpenDataComponentQuery(json_encode($open_data_component_query));
$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.opencrm.component.data.query' \
-d 'partner_id=apidoc' \
-d 'session=c78fc89a-2f19-4ec0-ad00-6e813923d96f' \
-d 'sign=C0741CCBBA15ED940BDF2CED7590D0DC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A58%3A32' \
-d 'v=2.0' \
-d 'open_data_component_query=null'

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

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

req.open_data_component_query="数据结构示例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.opencrm.component.data.query");
add_param(pRequest,"open_data_component_query","数据结构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.opencrm.component.data.query', {
	'open_data_component_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_component_data_query_response>
    <model>
        <data_update_time>2024-05-12</data_update_time>
        <component_index_data_dto_list>
            <component_index_data_d_t_o>
                <ds>2024-05-12</ds>
                <name>cart_uv</name>
                <legend>加购人数：统计时间内，所有会员中有加购的人数</legend>
                <value>1</value>
            </component_index_data_d_t_o>
        </component_index_data_dto_list>
    </model>
</opencrm_component_data_query_response>

{
    "opencrm_component_data_query_response":{
        "model":{
            "data_update_time":"2024-05-12",
            "component_index_data_dto_list":{
                "component_index_data_d_t_o":[
                    {
                        "ds":"2024-05-12",
                        "name":"cart_uv",
                        "legend":"加购人数：统计时间内，所有会员中有加购的人数",
                        "value":"1"
                    }
                ]
            }
        }
    }
}

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.opencrm.component.data.query (数据组件查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ