淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
action_name	String	可选	bai	action_name
book_id	Number	可选	1	book_id
book_id_online	Number	可选	1	book_id_online
book_name	String	可选	1	book_name
class_id	Number	可选	1	class_id
edit_id	Number	可选	1	edit_id
group_id	Number	可选	1	group_id
group_ord	Number	可选	1	group_ord
page	Number	可选	1	page
page_size	Number	可选	10	page_size
pen_name	String	可选	笔名	pen_name
sign_end_date	String	可选	2020-06-29 10:53	sign_end_date
sign_start_date	String	可选	2020-06-29 10:53	sign_start_date
type	Number	可选	3	type
category	Number	可选	1	categiry

名称	类型	示例值	描述
result	CommonResponse	result	result
data PlagiarizeTaskQueryRespV2 data data agreement_list ContractAgreementListBean [] agreement_list └ agreement_id String 2522 agreement_id └ author_name String 脆脆鲨很好new author_name └ book_id String 29000849 book_id └ book_id_online String 6013051 book_id_online └ book_name String 一个二十个字符 book_name └ class_id String 10016 class_id └ cr_time String 2021-03-29 14:22:54 cr_time └ edit_name String 张旭辉 edit_name └ group_id String 5 group_id └ group_name String ww group_name └ group_ord String 2 group_ord └ online_edit_id Number 0 online_edit_id └ sign_type String 80 sign_type └ user_id String 12 user_id └ category Number 1 category └ agreemnet_count Number 1 agreemnet_count └ page Number 1 page └ message String ok message └ state Number 200 state

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractAgreementsearchRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractAgreementsearchRequest();
req.setActionName("bai");
req.setBookId(1L);
req.setBookIdOnline(1L);
req.setBookName("1");
req.setClassId(1L);
req.setEditId(1L);
req.setGroupId(1L);
req.setGroupOrd(1L);
req.setPage(1L);
req.setPageSize(10L);
req.setPenName("笔名");
req.setSignEndDate("2020-06-29 10:53");
req.setSignStartDate("2020-06-29 10:53");
req.setType(3L);
req.setCategory(1L);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractAgreementsearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractAgreementsearchRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractAgreementsearchRequest();
req.ActionName = "bai";
req.BookId = 1L;
req.BookIdOnline = 1L;
req.BookName = "1";
req.ClassId = 1L;
req.EditId = 1L;
req.GroupId = 1L;
req.GroupOrd = 1L;
req.Page = 1L;
req.PageSize = 10L;
req.PenName = "笔名";
req.SignEndDate = "2020-06-29 10:53";
req.SignStartDate = "2020-06-29 10:53";
req.Type = 3L;
req.Category = 1L;
AlibabaShuqiOriginalBackendBackendapiOgnvcontractAgreementsearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractAgreementsearchRequest;
$req->setActionName("bai");
$req->setBookId("1");
$req->setBookIdOnline("1");
$req->setBookName("1");
$req->setClassId("1");
$req->setEditId("1");
$req->setGroupId("1");
$req->setGroupOrd("1");
$req->setPage("1");
$req->setPageSize("10");
$req->setPenName("笔名");
$req->setSignEndDate("2020-06-29 10:53");
$req->setSignStartDate("2020-06-29 10:53");
$req->setType("3");
$req->setCategory("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.agreementsearch' \
-d 'partner_id=apidoc' \
-d 'sign=87111D33895D6E179EC410D0BACAA751' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-18+03%3A21%3A43' \
-d 'v=2.0' \
-d 'action_name=bai' \
-d 'book_id=1' \
-d 'book_id_online=1' \
-d 'book_name=1' \
-d 'category=1' \
-d 'class_id=1' \
-d 'edit_id=1' \
-d 'group_id=1' \
-d 'group_ord=1' \
-d 'page=1' \
-d 'page_size=10' \
-d 'pen_name=%E7%AC%94%E5%90%8D' \
-d 'sign_end_date=2020-06-29+10%3A53' \
-d 'sign_start_date=2020-06-29+10%3A53' \
-d 'type=3'

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

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

req.action_name="bai"
req.book_id=1
req.book_id_online=1
req.book_name="1"
req.class_id=1
req.edit_id=1
req.group_id=1
req.group_ord=1
req.page=1
req.page_size=10
req.pen_name="笔名"
req.sign_end_date="2020-06-29 10:53"
req.sign_start_date="2020-06-29 10:53"
req.type=3
req.category=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.agreementsearch");
add_param(pRequest,"action_name","bai");
add_param(pRequest,"book_id","1");
add_param(pRequest,"book_id_online","1");
add_param(pRequest,"book_name","1");
add_param(pRequest,"class_id","1");
add_param(pRequest,"edit_id","1");
add_param(pRequest,"group_id","1");
add_param(pRequest,"group_ord","1");
add_param(pRequest,"page","1");
add_param(pRequest,"page_size","10");
add_param(pRequest,"pen_name","笔名");
add_param(pRequest,"sign_end_date","2020-06-29 10:53");
add_param(pRequest,"sign_start_date","2020-06-29 10:53");
add_param(pRequest,"type","3");
add_param(pRequest,"category","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.agreementsearch', {
	'action_name':'bai',
	'book_id':'1',
	'book_id_online':'1',
	'book_name':'1',
	'class_id':'1',
	'edit_id':'1',
	'group_id':'1',
	'group_ord':'1',
	'page':'1',
	'page_size':'10',
	'pen_name':'笔名',
	'sign_end_date':'2020-06-29 10:53',
	'sign_start_date':'2020-06-29 10:53',
	'type':'3',
	'category':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_backendapi_ognvcontract_agreementsearch_response>
    <result>
        <data>
            <agreement_list>
                <contract_agreement_list_bean>
                    <agreement_id>2522</agreement_id>
                    <author_name>脆脆鲨很好new</author_name>
                    <book_id>29000849</book_id>
                    <book_id_online>6013051</book_id_online>
                    <book_name>一个二十个字符</book_name>
                    <class_id>10016</class_id>
                    <cr_time>2021-03-29 14:22:54</cr_time>
                    <edit_name>张旭辉</edit_name>
                    <group_id>5</group_id>
                    <group_name>ww</group_name>
                    <group_ord>2</group_ord>
                    <online_edit_id>0</online_edit_id>
                    <sign_type>80</sign_type>
                    <user_id>12</user_id>
                    <category>1</category>
                </contract_agreement_list_bean>
            </agreement_list>
            <agreemnet_count>1</agreemnet_count>
            <page>1</page>
        </data>
        <message>ok</message>
        <state>200</state>
    </result>
</alibaba_shuqi_original_backend_backendapi_ognvcontract_agreementsearch_response>

{
    "alibaba_shuqi_original_backend_backendapi_ognvcontract_agreementsearch_response":{
        "result":{
            "data":{
                "agreement_list":{
                    "contract_agreement_list_bean":[
                        {
                            "agreement_id":"2522",
                            "author_name":"脆脆鲨很好new",
                            "book_id":"29000849",
                            "book_id_online":"6013051",
                            "book_name":"一个二十个字符",
                            "class_id":"10016",
                            "cr_time":"2021-03-29 14:22:54",
                            "edit_name":"张旭辉",
                            "group_id":"5",
                            "group_name":"ww",
                            "group_ord":"2",
                            "online_edit_id":0,
                            "sign_type":"80",
                            "user_id":"12",
                            "category":1
                        }
                    ]
                },
                "agreemnet_count":1,
                "page":1
            },
            "message":"ok",
            "state":200
        }
    }
}

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.agreementsearch (签约作品审核列表--补充协议列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ