淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
up_time_end	String	可选	2021-09-07 16:16	upTimeEnd
pen_name	String	可选	zml	penName
up_time_start	String	可选	2021-09-06 11:16	upTimeStart
is_rsync	Number	可选	1	isRsync
online_time_start	String	可选	2021-09-02 11:16	onlineTimeStart
page_size	Number	可选	20	pageSize
sort	String	可选	book_id	sort
type	Number	可选	1	type
book_name	String	可选	黑黑恶黑恶黑	bookName
second_class_id	Number	可选	1	secondClassId
book_id	Number	可选	6734173	bookId
is_end_write	Number	可选	1	isEndWrite
hide	Number	可选	1	hide
class_id	Number	可选	1	classId
book_gender	Number	可选	2	bookGender
page	Number	可选	1	page
online_time_end	String	可选	2021-09-04 11:16	onlineTimeEnd
is_update	Number	可选	1	isUpdate
action_name	String	可选	jason_zb	actionName
book_type	Number	可选	2	bookType
order	String	可选	asc	order

名称	类型	示例值	描述
result	CommonResponse	result	result
data SignSearchResp data data └ book_count Number 100 bookCount book_list BookList [] bookList bookList └ pen_name String 一朵小红花 penName └ is_rsync Number 2 isRsync └ chapter_count Number 2 chapterCount └ is_refinement Number 1 isRefinement └ class_name String 玄幻小说 className └ book_name String 测试机审 bookName └ second_class_id Number 22078 secondClassId └ user_id Number 406997319 userId └ book_id Number 6734214 bookId └ edit_name String 张旭辉 editName └ book_size Number 1624 bookSize └ is_end_write Number 1 isEndWrite └ class_id Number 22077 classId └ hide Number 1 hide └ new_chapter_name String fdsfs newChapterName └ new_chapter_time String 2021-12-03 17:01:08 newChapterTime └ online_time String 2021-12-03 17:01:08 onlineTime └ book_gender Number 1 bookGender └ second_class_name String 东方玄幻 secondClassName └ re_chapter_count Number 2 reChapterCount └ is_update Number 1 isUpdate └ book_type Number 1 bookType └ state Number 200 state └ message String 成功 message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOgnvalibookSignsearchexpRequest req = new AlibabaShuqiOriginalBackendOgnvalibookSignsearchexpRequest();
req.setUpTimeEnd("2021-09-07 16:16");
req.setPenName("zml");
req.setUpTimeStart("2021-09-06 11:16");
req.setIsRsync(1L);
req.setOnlineTimeStart("2021-09-02 11:16");
req.setPageSize(20L);
req.setSort("book_id");
req.setType(1L);
req.setBookName("黑黑恶黑恶黑");
req.setSecondClassId(1L);
req.setBookId(6734173L);
req.setIsEndWrite(1L);
req.setHide(1L);
req.setClassId(1L);
req.setBookGender(2L);
req.setPage(1L);
req.setOnlineTimeEnd("2021-09-04 11:16");
req.setIsUpdate(1L);
req.setActionName("jason_zb");
req.setBookType(2L);
req.setOrder("asc");
AlibabaShuqiOriginalBackendOgnvalibookSignsearchexpResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOgnvalibookSignsearchexpRequest req = new AlibabaShuqiOriginalBackendOgnvalibookSignsearchexpRequest();
req.UpTimeEnd = "2021-09-07 16:16";
req.PenName = "zml";
req.UpTimeStart = "2021-09-06 11:16";
req.IsRsync = 1L;
req.OnlineTimeStart = "2021-09-02 11:16";
req.PageSize = 20L;
req.Sort = "book_id";
req.Type = 1L;
req.BookName = "黑黑恶黑恶黑";
req.SecondClassId = 1L;
req.BookId = 6734173L;
req.IsEndWrite = 1L;
req.Hide = 1L;
req.ClassId = 1L;
req.BookGender = 2L;
req.Page = 1L;
req.OnlineTimeEnd = "2021-09-04 11:16";
req.IsUpdate = 1L;
req.ActionName = "jason_zb";
req.BookType = 2L;
req.Order = "asc";
AlibabaShuqiOriginalBackendOgnvalibookSignsearchexpResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendOgnvalibookSignsearchexpRequest;
$req->setUpTimeEnd("2021-09-07 16:16");
$req->setPenName("zml");
$req->setUpTimeStart("2021-09-06 11:16");
$req->setIsRsync("1");
$req->setOnlineTimeStart("2021-09-02 11:16");
$req->setPageSize("20");
$req->setSort("book_id");
$req->setType("1");
$req->setBookName("黑黑恶黑恶黑");
$req->setSecondClassId("1");
$req->setBookId("6734173");
$req->setIsEndWrite("1");
$req->setHide("1");
$req->setClassId("1");
$req->setBookGender("2");
$req->setPage("1");
$req->setOnlineTimeEnd("2021-09-04 11:16");
$req->setIsUpdate("1");
$req->setActionName("jason_zb");
$req->setBookType("2");
$req->setOrder("asc");
$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.original.backend.ognvalibook.signsearchexp' \
-d 'partner_id=apidoc' \
-d 'sign=2FDFDCB732DC2DFCED0083023370C6C5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-12+07%3A04%3A48' \
-d 'v=2.0' \
-d 'action_name=jason_zb' \
-d 'book_gender=2' \
-d 'book_id=6734173' \
-d 'book_name=%E9%BB%91%E9%BB%91%E6%81%B6%E9%BB%91%E6%81%B6%E9%BB%91' \
-d 'book_type=2' \
-d 'class_id=1' \
-d 'hide=1' \
-d 'is_end_write=1' \
-d 'is_rsync=1' \
-d 'is_update=1' \
-d 'online_time_end=2021-09-04+11%3A16' \
-d 'online_time_start=2021-09-02+11%3A16' \
-d 'order=asc' \
-d 'page=1' \
-d 'page_size=20' \
-d 'pen_name=zml' \
-d 'second_class_id=1' \
-d 'sort=book_id' \
-d 'type=1' \
-d 'up_time_end=2021-09-07+16%3A16' \
-d 'up_time_start=2021-09-06+11%3A16'

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

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

req.up_time_end="2021-09-07 16:16"
req.pen_name="zml"
req.up_time_start="2021-09-06 11:16"
req.is_rsync=1
req.online_time_start="2021-09-02 11:16"
req.page_size=20
req.sort="book_id"
req.type=1
req.book_name="黑黑恶黑恶黑"
req.second_class_id=1
req.book_id=6734173
req.is_end_write=1
req.hide=1
req.class_id=1
req.book_gender=2
req.page=1
req.online_time_end="2021-09-04 11:16"
req.is_update=1
req.action_name="jason_zb"
req.book_type=2
req.order="asc"
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.original.backend.ognvalibook.signsearchexp");
add_param(pRequest,"up_time_end","2021-09-07 16:16");
add_param(pRequest,"pen_name","zml");
add_param(pRequest,"up_time_start","2021-09-06 11:16");
add_param(pRequest,"is_rsync","1");
add_param(pRequest,"online_time_start","2021-09-02 11:16");
add_param(pRequest,"page_size","20");
add_param(pRequest,"sort","book_id");
add_param(pRequest,"type","1");
add_param(pRequest,"book_name","黑黑恶黑恶黑");
add_param(pRequest,"second_class_id","1");
add_param(pRequest,"book_id","6734173");
add_param(pRequest,"is_end_write","1");
add_param(pRequest,"hide","1");
add_param(pRequest,"class_id","1");
add_param(pRequest,"book_gender","2");
add_param(pRequest,"page","1");
add_param(pRequest,"online_time_end","2021-09-04 11:16");
add_param(pRequest,"is_update","1");
add_param(pRequest,"action_name","jason_zb");
add_param(pRequest,"book_type","2");
add_param(pRequest,"order","asc");
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.original.backend.ognvalibook.signsearchexp', {
	'up_time_end':'2021-09-07 16:16',
	'pen_name':'zml',
	'up_time_start':'2021-09-06 11:16',
	'is_rsync':'1',
	'online_time_start':'2021-09-02 11:16',
	'page_size':'20',
	'sort':'book_id',
	'type':'1',
	'book_name':'黑黑恶黑恶黑',
	'second_class_id':'1',
	'book_id':'6734173',
	'is_end_write':'1',
	'hide':'1',
	'class_id':'1',
	'book_gender':'2',
	'page':'1',
	'online_time_end':'2021-09-04 11:16',
	'is_update':'1',
	'action_name':'jason_zb',
	'book_type':'2',
	'order':'asc'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_ognvalibook_signsearchexp_response>
    <result>
        <data>
            <book_count>100</book_count>
            <book_list>
                <book_list>
                    <pen_name>一朵小红花</pen_name>
                    <is_rsync>2</is_rsync>
                    <chapter_count>2</chapter_count>
                    <is_refinement>1</is_refinement>
                    <class_name>玄幻小说</class_name>
                    <book_name>测试机审</book_name>
                    <second_class_id>22078</second_class_id>
                    <user_id>406997319</user_id>
                    <book_id>6734214</book_id>
                    <edit_name>张旭辉</edit_name>
                    <book_size>1624</book_size>
                    <is_end_write>1</is_end_write>
                    <class_id>22077</class_id>
                    <hide>1</hide>
                    <new_chapter_name>fdsfs</new_chapter_name>
                    <new_chapter_time>2021-12-03 17:01:08</new_chapter_time>
                    <online_time>2021-12-03 17:01:08</online_time>
                    <book_gender>1</book_gender>
                    <second_class_name>东方玄幻</second_class_name>
                    <re_chapter_count>2</re_chapter_count>
                    <is_update>1</is_update>
                    <book_type>1</book_type>
                </book_list>
            </book_list>
        </data>
        <state>200</state>
        <message>成功</message>
    </result>
</alibaba_shuqi_original_backend_ognvalibook_signsearchexp_response>

{
    "alibaba_shuqi_original_backend_ognvalibook_signsearchexp_response":{
        "result":{
            "data":{
                "book_count":100,
                "book_list":{
                    "book_list":[
                        {
                            "pen_name":"一朵小红花",
                            "is_rsync":2,
                            "chapter_count":2,
                            "is_refinement":1,
                            "class_name":"玄幻小说",
                            "book_name":"测试机审",
                            "second_class_id":22078,
                            "user_id":406997319,
                            "book_id":6734214,
                            "edit_name":"张旭辉",
                            "book_size":1624,
                            "is_end_write":1,
                            "class_id":22077,
                            "hide":1,
                            "new_chapter_name":"fdsfs",
                            "new_chapter_time":"2021-12-03 17:01:08",
                            "online_time":"2021-12-03 17:01:08",
                            "book_gender":1,
                            "second_class_name":"东方玄幻",
                            "re_chapter_count":2,
                            "is_update":1,
                            "book_type":1
                        }
                    ]
                }
            },
            "state":200,
            "message":"成功"
        }
    }
}

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.original.backend.ognvalibook.signsearchexp (精修作品导出)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ