淘宝开放平台 - 文档中心

请求地址：

环境	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	可选	baijiankai	action_name
book_id	Number	可选	300000333	book_id
user_id	Number	可选	268542438	user_id

名称	类型	示例值	描述
result	CommonResponse	result	result
data PlagiarizeTaskQueryRespV2 data data addition_info AdditionInfo [] addition_info └ action_name String baijiankai action_name └ book_name String 签约 book_name └ contract_name String 阿里巴巴文学原创签约合同——全版权独家纯分成20年 contract_name └ contract_ord String ALWX-IP-20210824143001-202101 contract_ord └ cr_time String 2021-08-24 16:33:58 cr_time └ down_type Number 8 down_type └ id Number 2653 id └ master_contract_ord String ALWX-IP-20210824143001 master_contract_ord └ pen_name String 缓存 pen_name └ scanning_url String 1629794226_929323.pdf scanning_url └ sign_pdf_url String 1629794226_929323.pdf sign_pdf_url └ sign_type Number 80 sign_type └ type Number null type └ up_time String 2021-09-14 10:57:52 up_time agreement_info AdditionInfo [] agreement_info └ action_name String baijiankai action_name └ book_name String 签约 book_name └ contract_name String 阿里文学原创签约合同-补充协议 contract_name └ contract_ord String ALWX-IP-20210824143001-202101 contract_ord └ cr_time String 2021-09-14 10:57:52 cr_time └ down_type Number 8 down_type └ id Number 2653 id └ master_contract_ord String ALWX-IP-20210824143001-202101 master_contract_ord └ pen_name String 缓存 pen_name └ scanning_url String 1629794226_929323.pdf scanning_url └ sign_pdf_url String 1629794226_929323.pdf sign_pdf_url └ sign_type Number 80 sign_type └ type Number 3 type └ up_time String 2021-09-14 10:57:52 up_time master_info MasterInfo 签约 master_info └ book_name String 签约 book_name └ contract_name String 阿里巴巴文学原创签约合同——全版权独家纯分成20年 contract_name └ contract_url String 1629794157_120267.pdf contract_url └ cr_time String 1629794157_120267.pdf cr_time └ down_type Number 2021-08-24 16:33:58 down_type └ sign_pdf_url String 1629794226_929323.pdf sign_pdf_url └ sign_type Number 80 sign_type └ up_time String 2021-08-24 16:38:08 up_time └ message String ok message └ state Number 200 state

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractGetcontractsRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractGetcontractsRequest();
req.setActionName("baijiankai");
req.setBookId(300000333L);
req.setUserId(268542438L);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractGetcontractsResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractGetcontractsRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractGetcontractsRequest();
req.ActionName = "baijiankai";
req.BookId = 300000333L;
req.UserId = 268542438L;
AlibabaShuqiOriginalBackendBackendapiOgnvcontractGetcontractsResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractGetcontractsRequest;
$req->setActionName("baijiankai");
$req->setBookId("300000333");
$req->setUserId("268542438");
$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.getcontracts' \
-d 'partner_id=apidoc' \
-d 'sign=0E79608F8772CF72ABB5DE58FAD00FB8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-18+03%3A43%3A45' \
-d 'v=2.0' \
-d 'action_name=baijiankai' \
-d 'book_id=300000333' \
-d 'user_id=268542438'

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

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

req.action_name="baijiankai"
req.book_id=300000333
req.user_id=268542438
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.getcontracts");
add_param(pRequest,"action_name","baijiankai");
add_param(pRequest,"book_id","300000333");
add_param(pRequest,"user_id","268542438");
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.getcontracts', {
	'action_name':'baijiankai',
	'book_id':'300000333',
	'user_id':'268542438'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_backendapi_ognvcontract_getcontracts_response>
    <result>
        <data>
            <addition_info>
                <addition_info>
                    <action_name>baijiankai</action_name>
                    <book_name>签约</book_name>
                    <contract_name>阿里巴巴文学原创签约合同——全版权独家纯分成20年</contract_name>
                    <contract_ord>ALWX-IP-20210824143001-202101</contract_ord>
                    <cr_time>2021-08-24 16:33:58</cr_time>
                    <down_type>8</down_type>
                    <id>2653</id>
                    <master_contract_ord>ALWX-IP-20210824143001</master_contract_ord>
                    <pen_name>缓存</pen_name>
                    <scanning_url>1629794226_929323.pdf</scanning_url>
                    <sign_pdf_url>1629794226_929323.pdf</sign_pdf_url>
                    <sign_type>80</sign_type>
                    <type>null</type>
                    <up_time>2021-09-14 10:57:52</up_time>
                </addition_info>
            </addition_info>
            <agreement_info>
                <addition_info>
                    <action_name>baijiankai</action_name>
                    <book_name>签约</book_name>
                    <contract_name>阿里文学原创签约合同-补充协议</contract_name>
                    <contract_ord>ALWX-IP-20210824143001-202101</contract_ord>
                    <cr_time>2021-09-14 10:57:52</cr_time>
                    <down_type>8</down_type>
                    <id>2653</id>
                    <master_contract_ord>ALWX-IP-20210824143001-202101</master_contract_ord>
                    <pen_name>缓存</pen_name>
                    <scanning_url>1629794226_929323.pdf</scanning_url>
                    <sign_pdf_url>1629794226_929323.pdf</sign_pdf_url>
                    <sign_type>80</sign_type>
                    <type>3</type>
                    <up_time>2021-09-14 10:57:52</up_time>
                </addition_info>
            </agreement_info>
            <master_info>
                <book_name>签约</book_name>
                <contract_name>阿里巴巴文学原创签约合同——全版权独家纯分成20年</contract_name>
                <contract_url>1629794157_120267.pdf</contract_url>
                <cr_time>1629794157_120267.pdf</cr_time>
                <down_type>2021-08-24 16:33:58</down_type>
                <sign_pdf_url>1629794226_929323.pdf</sign_pdf_url>
                <sign_type>80</sign_type>
                <up_time>2021-08-24 16:38:08</up_time>
            </master_info>
        </data>
        <message>ok</message>
        <state>200</state>
    </result>
</alibaba_shuqi_original_backend_backendapi_ognvcontract_getcontracts_response>

{
    "alibaba_shuqi_original_backend_backendapi_ognvcontract_getcontracts_response":{
        "result":{
            "data":{
                "addition_info":{
                    "addition_info":[
                        {
                            "action_name":"baijiankai",
                            "book_name":"签约",
                            "contract_name":"阿里巴巴文学原创签约合同——全版权独家纯分成20年",
                            "contract_ord":"ALWX-IP-20210824143001-202101",
                            "cr_time":"2021-08-24 16:33:58",
                            "down_type":8,
                            "id":2653,
                            "master_contract_ord":"ALWX-IP-20210824143001",
                            "pen_name":"缓存",
                            "scanning_url":"1629794226_929323.pdf",
                            "sign_pdf_url":"1629794226_929323.pdf",
                            "sign_type":80,
                            "type":null,
                            "up_time":"2021-09-14 10:57:52"
                        }
                    ]
                },
                "agreement_info":{
                    "addition_info":[
                        {
                            "action_name":"baijiankai",
                            "book_name":"签约",
                            "contract_name":"阿里文学原创签约合同-补充协议",
                            "contract_ord":"ALWX-IP-20210824143001-202101",
                            "cr_time":"2021-09-14 10:57:52",
                            "down_type":8,
                            "id":2653,
                            "master_contract_ord":"ALWX-IP-20210824143001-202101",
                            "pen_name":"缓存",
                            "scanning_url":"1629794226_929323.pdf",
                            "sign_pdf_url":"1629794226_929323.pdf",
                            "sign_type":80,
                            "type":3,
                            "up_time":"2021-09-14 10:57:52"
                        }
                    ]
                },
                "master_info":{
                    "book_name":"签约",
                    "contract_name":"阿里巴巴文学原创签约合同——全版权独家纯分成20年",
                    "contract_url":"1629794157_120267.pdf",
                    "cr_time":"1629794157_120267.pdf",
                    "down_type":2021-08-24 16:33:58,
                    "sign_pdf_url":"1629794226_929323.pdf",
                    "sign_type":80,
                    "up_time":"2021-08-24 16:38:08"
                }
            },
            "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.getcontracts (某本书补充协议列表（线上、线下）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ