淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
emp_id	String	可选	1	工号
sq_bids	Number	可选	1	书旗bid
inc_cp_date	Number	可选	1	新增cp时间
qimao_cp_names	String	可选	1	七猫cp名
book_level	String	可选	1	书籍等级
page_size	Number	可选	1	每页大小
source	Number	可选	1	数据源
sq_top_class	Number	可选	1	书旗书籍类型
rival_author_name	String	可选	1	竞对作者名
date_ym	Number	可选	1	默认数据归属年月
sq_book_name	String	可选	1	书旗书籍名
author_level	String	可选	1	作者等级
rival_book_name	String	可选	1	竞对书名
book_in_copr	Number	可选	1	当前书籍是否在书旗版权库
show_columns	String	可选	1	自定义展示列
order	String	可选	1	升序
book_status	Number	可选	1	书籍上下架状态
sq_channel	String	可选	1	书旗频道
out_cate_name	String	可选	1	外层分类名
serial_state	Number	可选	1	连载状态
sort	String	可选	1	排序字段
inner_cate_name	String	可选	1	内层分类名
book_classes	String	可选	1	书籍类型
offline_date	Number	可选	1	下架书时间
sq_category	String	可选	1	书旗分类id
sq_cp_id	Number	可选	1	书旗cpid
online_inc_date	Number	可选	1	新增上架书时间
is_short_story	Number	可选	1	是否短篇
page	Number	可选	1	页数
is_broken	Number	可选	1	是否断更
product_code	Number	可选	1	产品码，1：主端，3：UC，4：夸克
product_status	Number	可选	1	产品线上状态，1：正常上架，2：隐藏可阅读-新章节可读，3：隐藏可阅读-新章节不可读，4：下架不能阅读
copr_expire_status	Number	可选	1	版权到期状态，1：正常，2：临期，3：到期，正常包括临期
shelf_check_status	Number	可选	1	审核状态，300001：上书待审核、300002：上书驳回、400001：内容待审核、400002：内容审核驳回、400011：内容待排查、400012：内容排查驳回、400003：待定价、500001：待上架、500002：已上架
no_copr_reason	String	可选	""	无法引入原因
business_belong_list	String	可选	""	七猫归属榜单，包括：必读榜、大热榜、热搜榜、新书榜

名称	类型	示例值	描述
state	Number	200	状态码
message	String	success	返回信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiContentBackendRivalExportrivalRequest req = new AlibabaShuqiContentBackendRivalExportrivalRequest();
req.setEmpId("1");
req.setSqBids(1L);
req.setIncCpDate(1L);
req.setQimaoCpNames("1");
req.setBookLevel("1");
req.setPageSize(1L);
req.setSource(1L);
req.setSqTopClass(1L);
req.setRivalAuthorName("1");
req.setDateYm(1L);
req.setSqBookName("1");
req.setAuthorLevel("1");
req.setRivalBookName("1");
req.setBookInCopr(1L);
req.setShowColumns("1");
req.setOrder("1");
req.setBookStatus(1L);
req.setSqChannel("1");
req.setOutCateName("1");
req.setSerialState(1L);
req.setSort("1");
req.setInnerCateName("1");
req.setBookClasses("1");
req.setOfflineDate(1L);
req.setSqCategory("1");
req.setSqCpId(1L);
req.setOnlineIncDate(1L);
req.setIsShortStory(1L);
req.setPage(1L);
req.setIsBroken(1L);
req.setProductCode(1L);
req.setProductStatus(1L);
req.setCoprExpireStatus(1L);
req.setShelfCheckStatus(1L);
req.setNoCoprReason("\"\"");
req.setBusinessBelongList("\"\"");
AlibabaShuqiContentBackendRivalExportrivalResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiContentBackendRivalExportrivalRequest req = new AlibabaShuqiContentBackendRivalExportrivalRequest();
req.EmpId = "1";
req.SqBids = 1L;
req.IncCpDate = 1L;
req.QimaoCpNames = "1";
req.BookLevel = "1";
req.PageSize = 1L;
req.Source = 1L;
req.SqTopClass = 1L;
req.RivalAuthorName = "1";
req.DateYm = 1L;
req.SqBookName = "1";
req.AuthorLevel = "1";
req.RivalBookName = "1";
req.BookInCopr = 1L;
req.ShowColumns = "1";
req.Order = "1";
req.BookStatus = 1L;
req.SqChannel = "1";
req.OutCateName = "1";
req.SerialState = 1L;
req.Sort = "1";
req.InnerCateName = "1";
req.BookClasses = "1";
req.OfflineDate = 1L;
req.SqCategory = "1";
req.SqCpId = 1L;
req.OnlineIncDate = 1L;
req.IsShortStory = 1L;
req.Page = 1L;
req.IsBroken = 1L;
req.ProductCode = 1L;
req.ProductStatus = 1L;
req.CoprExpireStatus = 1L;
req.ShelfCheckStatus = 1L;
req.NoCoprReason = "\"\"";
req.BusinessBelongList = "\"\"";
AlibabaShuqiContentBackendRivalExportrivalResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiContentBackendRivalExportrivalRequest;
$req->setEmpId("1");
$req->setSqBids("1");
$req->setIncCpDate("1");
$req->setQimaoCpNames("1");
$req->setBookLevel("1");
$req->setPageSize("1");
$req->setSource("1");
$req->setSqTopClass("1");
$req->setRivalAuthorName("1");
$req->setDateYm("1");
$req->setSqBookName("1");
$req->setAuthorLevel("1");
$req->setRivalBookName("1");
$req->setBookInCopr("1");
$req->setShowColumns("1");
$req->setOrder("1");
$req->setBookStatus("1");
$req->setSqChannel("1");
$req->setOutCateName("1");
$req->setSerialState("1");
$req->setSort("1");
$req->setInnerCateName("1");
$req->setBookClasses("1");
$req->setOfflineDate("1");
$req->setSqCategory("1");
$req->setSqCpId("1");
$req->setOnlineIncDate("1");
$req->setIsShortStory("1");
$req->setPage("1");
$req->setIsBroken("1");
$req->setProductCode("1");
$req->setProductStatus("1");
$req->setCoprExpireStatus("1");
$req->setShelfCheckStatus("1");
$req->setNoCoprReason("\"\"");
$req->setBusinessBelongList("\"\"");
$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=alibaba.shuqi.content.backend.rival.exportrival' \
-d 'partner_id=apidoc' \
-d 'sign=D532A4BC40631A029CC1480D1CFF8DF3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-13+04%3A10%3A05' \
-d 'v=2.0' \
-d 'author_level=1' \
-d 'book_classes=1' \
-d 'book_in_copr=1' \
-d 'book_level=1' \
-d 'book_status=1' \
-d 'business_belong_list=%5C%22%5C%22' \
-d 'copr_expire_status=1' \
-d 'date_ym=1' \
-d 'emp_id=1' \
-d 'inc_cp_date=1' \
-d 'inner_cate_name=1' \
-d 'is_broken=1' \
-d 'is_short_story=1' \
-d 'no_copr_reason=%5C%22%5C%22' \
-d 'offline_date=1' \
-d 'online_inc_date=1' \
-d 'order=1' \
-d 'out_cate_name=1' \
-d 'page=1' \
-d 'page_size=1' \
-d 'product_code=1' \
-d 'product_status=1' \
-d 'qimao_cp_names=1' \
-d 'rival_author_name=1' \
-d 'rival_book_name=1' \
-d 'serial_state=1' \
-d 'shelf_check_status=1' \
-d 'show_columns=1' \
-d 'sort=1' \
-d 'source=1' \
-d 'sq_bids=1' \
-d 'sq_book_name=1' \
-d 'sq_category=1' \
-d 'sq_channel=1' \
-d 'sq_cp_id=1' \
-d 'sq_top_class=1'

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

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

req.emp_id="1"
req.sq_bids=1
req.inc_cp_date=1
req.qimao_cp_names="1"
req.book_level="1"
req.page_size=1
req.source=1
req.sq_top_class=1
req.rival_author_name="1"
req.date_ym=1
req.sq_book_name="1"
req.author_level="1"
req.rival_book_name="1"
req.book_in_copr=1
req.show_columns="1"
req.order="1"
req.book_status=1
req.sq_channel="1"
req.out_cate_name="1"
req.serial_state=1
req.sort="1"
req.inner_cate_name="1"
req.book_classes="1"
req.offline_date=1
req.sq_category="1"
req.sq_cp_id=1
req.online_inc_date=1
req.is_short_story=1
req.page=1
req.is_broken=1
req.product_code=1
req.product_status=1
req.copr_expire_status=1
req.shelf_check_status=1
req.no_copr_reason="\"\""
req.business_belong_list="\"\""
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,"alibaba.shuqi.content.backend.rival.exportrival");
add_param(pRequest,"emp_id","1");
add_param(pRequest,"sq_bids","1");
add_param(pRequest,"inc_cp_date","1");
add_param(pRequest,"qimao_cp_names","1");
add_param(pRequest,"book_level","1");
add_param(pRequest,"page_size","1");
add_param(pRequest,"source","1");
add_param(pRequest,"sq_top_class","1");
add_param(pRequest,"rival_author_name","1");
add_param(pRequest,"date_ym","1");
add_param(pRequest,"sq_book_name","1");
add_param(pRequest,"author_level","1");
add_param(pRequest,"rival_book_name","1");
add_param(pRequest,"book_in_copr","1");
add_param(pRequest,"show_columns","1");
add_param(pRequest,"order","1");
add_param(pRequest,"book_status","1");
add_param(pRequest,"sq_channel","1");
add_param(pRequest,"out_cate_name","1");
add_param(pRequest,"serial_state","1");
add_param(pRequest,"sort","1");
add_param(pRequest,"inner_cate_name","1");
add_param(pRequest,"book_classes","1");
add_param(pRequest,"offline_date","1");
add_param(pRequest,"sq_category","1");
add_param(pRequest,"sq_cp_id","1");
add_param(pRequest,"online_inc_date","1");
add_param(pRequest,"is_short_story","1");
add_param(pRequest,"page","1");
add_param(pRequest,"is_broken","1");
add_param(pRequest,"product_code","1");
add_param(pRequest,"product_status","1");
add_param(pRequest,"copr_expire_status","1");
add_param(pRequest,"shelf_check_status","1");
add_param(pRequest,"no_copr_reason","\"\"");
add_param(pRequest,"business_belong_list","\"\"");
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('alibaba.shuqi.content.backend.rival.exportrival', {
	'emp_id':'1',
	'sq_bids':'1',
	'inc_cp_date':'1',
	'qimao_cp_names':'1',
	'book_level':'1',
	'page_size':'1',
	'source':'1',
	'sq_top_class':'1',
	'rival_author_name':'1',
	'date_ym':'1',
	'sq_book_name':'1',
	'author_level':'1',
	'rival_book_name':'1',
	'book_in_copr':'1',
	'show_columns':'1',
	'order':'1',
	'book_status':'1',
	'sq_channel':'1',
	'out_cate_name':'1',
	'serial_state':'1',
	'sort':'1',
	'inner_cate_name':'1',
	'book_classes':'1',
	'offline_date':'1',
	'sq_category':'1',
	'sq_cp_id':'1',
	'online_inc_date':'1',
	'is_short_story':'1',
	'page':'1',
	'is_broken':'1',
	'product_code':'1',
	'product_status':'1',
	'copr_expire_status':'1',
	'shelf_check_status':'1',
	'no_copr_reason':'\"\"',
	'business_belong_list':'\"\"'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_content_backend_rival_exportrival_response>
    <state>200</state>
    <message>success</message>
</alibaba_shuqi_content_backend_rival_exportrival_response>

{
    "alibaba_shuqi_content_backend_rival_exportrival_response":{
        "state":200,
        "message":"success"
    }
}

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下载

书旗内容文巢

alibaba.shuqi.content.backend.rival.exportrival (导出竞对列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ