淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
page	String	可选	1	page
page_size	String	可选	20	pageSize
book_id	String	可选	1	bookId
book_id_online	String	可选	1	bookIdOnline
contract_id	String	可选	1	contractId
contract_ord	String	可选	1	contractOrd
sort	String	可选	1	sort
order	String	可选	1	order
book_name	String	可选	1	bookName
cr_start_time	String	可选	1	crStartTime
cr_end_time	String	可选	1	crEndTime
timestamp_int	String	可选	1	timestamp
sign_str	String	可选	1	sign
edit_id	String	可选	106	editId
status	Number	可选	1	status

名称	类型	示例值	描述
data	Data		系统自动生成
└ book_count Number 389 bookCount └ page Number 20 page book_list BookList [] bookList └ contract_ord String ALWX-IP-20211011141001 contractOrd └ pen_name String fmm penName └ cr_time String 2021-10-11 15:47:17 crTime └ sign_time String 2021-10-11 15:52:17 signTime └ book_id_online Number 6734189 bookIdOnline └ book_name String 诛仙剑阵 bookName └ user_id Number 407798057 userId └ book_id Number 300000356 bookId └ edit_name String 付明明 editName └ sign_pdf_url String 1633938908_474729.pdf signPdfUrl └ group_name String ww groupName └ contract_url String 1633938740_893250.pdf contractUrl └ scanning_url String 1634206558_285779.zip scanningUrl └ contract_id Number 10141 contractId └ online_edit_id String 0 onlineEditId └ sign_type String 90 signType └ contract_name String 阿里巴巴文学原创签约合同——永久保底分成 contractName └ oa_id String oald oaId └ re_sign_able Number 1 reSignAble └ status Number 2 status └ esign_contract_id Number 2323432 esignContractId └ sign_type_show String 审核通过审核通过
state	Number	200	state
message	String	成功	message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractContractsearchRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractContractsearchRequest();
req.setPage("1");
req.setPageSize("20");
req.setBookId("1");
req.setBookIdOnline("1");
req.setContractId("1");
req.setContractOrd("1");
req.setSort("1");
req.setOrder("1");
req.setBookName("1");
req.setCrStartTime("1");
req.setCrEndTime("1");
req.setTimestampInt("1");
req.setSignStr("1");
req.setEditId("106");
req.setStatus(1L);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractContractsearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractContractsearchRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractContractsearchRequest();
req.Page = "1";
req.PageSize = "20";
req.BookId = "1";
req.BookIdOnline = "1";
req.ContractId = "1";
req.ContractOrd = "1";
req.Sort = "1";
req.Order = "1";
req.BookName = "1";
req.CrStartTime = "1";
req.CrEndTime = "1";
req.TimestampInt = "1";
req.SignStr = "1";
req.EditId = "106";
req.Status = 1L;
AlibabaShuqiOriginalBackendBackendapiOgnvcontractContractsearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractContractsearchRequest;
$req->setPage("1");
$req->setPageSize("20");
$req->setBookId("1");
$req->setBookIdOnline("1");
$req->setContractId("1");
$req->setContractOrd("1");
$req->setSort("1");
$req->setOrder("1");
$req->setBookName("1");
$req->setCrStartTime("1");
$req->setCrEndTime("1");
$req->setTimestampInt("1");
$req->setSignStr("1");
$req->setEditId("106");
$req->setStatus("1");
$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.backendapi.ognvcontract.contractsearch' \
-d 'partner_id=apidoc' \
-d 'sign=01AF123614F49FB51B098A823A36FB88' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-14+17%3A01%3A28' \
-d 'v=2.0' \
-d 'book_id=1' \
-d 'book_id_online=1' \
-d 'book_name=1' \
-d 'contract_id=1' \
-d 'contract_ord=1' \
-d 'cr_end_time=1' \
-d 'cr_start_time=1' \
-d 'edit_id=106' \
-d 'order=1' \
-d 'page=1' \
-d 'page_size=20' \
-d 'sign_str=1' \
-d 'sort=1' \
-d 'status=1' \
-d 'timestamp_int=1'

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

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

req.page="1"
req.page_size="20"
req.book_id="1"
req.book_id_online="1"
req.contract_id="1"
req.contract_ord="1"
req.sort="1"
req.order="1"
req.book_name="1"
req.cr_start_time="1"
req.cr_end_time="1"
req.timestamp_int="1"
req.sign_str="1"
req.edit_id="106"
req.status=1
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.backendapi.ognvcontract.contractsearch");
add_param(pRequest,"page","1");
add_param(pRequest,"page_size","20");
add_param(pRequest,"book_id","1");
add_param(pRequest,"book_id_online","1");
add_param(pRequest,"contract_id","1");
add_param(pRequest,"contract_ord","1");
add_param(pRequest,"sort","1");
add_param(pRequest,"order","1");
add_param(pRequest,"book_name","1");
add_param(pRequest,"cr_start_time","1");
add_param(pRequest,"cr_end_time","1");
add_param(pRequest,"timestamp_int","1");
add_param(pRequest,"sign_str","1");
add_param(pRequest,"edit_id","106");
add_param(pRequest,"status","1");
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.backendapi.ognvcontract.contractsearch', {
	'page':'1',
	'page_size':'20',
	'book_id':'1',
	'book_id_online':'1',
	'contract_id':'1',
	'contract_ord':'1',
	'sort':'1',
	'order':'1',
	'book_name':'1',
	'cr_start_time':'1',
	'cr_end_time':'1',
	'timestamp_int':'1',
	'sign_str':'1',
	'edit_id':'106',
	'status':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_backendapi_ognvcontract_contractsearch_response>
    <data>
        <book_count>389</book_count>
        <page>20</page>
        <book_list>
            <book_list>
                <contract_ord>ALWX-IP-20211011141001</contract_ord>
                <pen_name>fmm</pen_name>
                <cr_time>2021-10-11 15:47:17</cr_time>
                <sign_time>2021-10-11 15:52:17</sign_time>
                <book_id_online>6734189</book_id_online>
                <book_name>诛仙剑阵</book_name>
                <user_id>407798057</user_id>
                <book_id>300000356</book_id>
                <edit_name>付明明</edit_name>
                <sign_pdf_url>1633938908_474729.pdf</sign_pdf_url>
                <group_name>ww</group_name>
                <contract_url>1633938740_893250.pdf</contract_url>
                <scanning_url>1634206558_285779.zip</scanning_url>
                <contract_id>10141</contract_id>
                <online_edit_id>0</online_edit_id>
                <sign_type>90</sign_type>
                <contract_name>阿里巴巴文学原创签约合同——永久保底分成</contract_name>
                <oa_id>oald</oa_id>
                <re_sign_able>1</re_sign_able>
                <status>2</status>
                <esign_contract_id>2323432</esign_contract_id>
                <sign_type_show>审核通过</sign_type_show>
            </book_list>
        </book_list>
    </data>
    <state>200</state>
    <message>成功</message>
</alibaba_shuqi_original_backend_backendapi_ognvcontract_contractsearch_response>

{
    "alibaba_shuqi_original_backend_backendapi_ognvcontract_contractsearch_response":{
        "data":{
            "book_count":389,
            "page":20,
            "book_list":{
                "book_list":[
                    {
                        "contract_ord":"ALWX-IP-20211011141001",
                        "pen_name":"fmm",
                        "cr_time":"2021-10-11 15:47:17",
                        "sign_time":"2021-10-11 15:52:17",
                        "book_id_online":6734189,
                        "book_name":"诛仙剑阵",
                        "user_id":407798057,
                        "book_id":300000356,
                        "edit_name":"付明明",
                        "sign_pdf_url":"1633938908_474729.pdf",
                        "group_name":"ww",
                        "contract_url":"1633938740_893250.pdf",
                        "scanning_url":"1634206558_285779.zip",
                        "contract_id":10141,
                        "online_edit_id":"0",
                        "sign_type":"90",
                        "contract_name":"阿里巴巴文学原创签约合同——永久保底分成",
                        "oa_id":"oald ",
                        "re_sign_able":1,
                        "status":2,
                        "esign_contract_id":2323432,
                        "sign_type_show":"审核通过"
                    }
                ]
            }
        },
        "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.backendapi.ognvcontract.contractsearch (合同管理列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ