淘宝开放平台

请求地址：

环境	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
agreement_id	Number	可选	23	agreement_id
book_id	Number	可选	300000347	book_id
contract_text	String	可选	{}	contract_text
master_id	Number	可选	10143	master_id
reason	String	可选	理由	reason
type	Number	可选	1	type
user_id	Number	可选	1213	user_id

名称	类型	示例值	描述
result	CommonResponse	result	result
└ message String ok message └ state Number 200 state

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractUpbookcontractRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractUpbookcontractRequest();
req.setActionName("baijiankai");
req.setAgreementId(23L);
req.setBookId(300000347L);
req.setContractText("{}");
req.setMasterId(10143L);
req.setReason("理由");
req.setType(1L);
req.setUserId(1213L);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractUpbookcontractResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvcontractUpbookcontractRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractUpbookcontractRequest();
req.ActionName = "baijiankai";
req.AgreementId = 23L;
req.BookId = 300000347L;
req.ContractText = "{}";
req.MasterId = 10143L;
req.Reason = "理由";
req.Type = 1L;
req.UserId = 1213L;
AlibabaShuqiOriginalBackendBackendapiOgnvcontractUpbookcontractResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendBackendapiOgnvcontractUpbookcontractRequest;
$req->setActionName("baijiankai");
$req->setAgreementId("23");
$req->setBookId("300000347");
$req->setContractText("{}");
$req->setMasterId("10143");
$req->setReason("理由");
$req->setType("1");
$req->setUserId("1213");
$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.upbookcontract' \
-d 'partner_id=apidoc' \
-d 'sign=125D9D064B7C90F0F4AAF9A121574297' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-11+13%3A52%3A26' \
-d 'v=2.0' \
-d 'action_name=baijiankai' \
-d 'agreement_id=23' \
-d 'book_id=300000347' \
-d 'contract_text=%7B%7D' \
-d 'master_id=10143' \
-d 'reason=%E7%90%86%E7%94%B1' \
-d 'type=1' \
-d 'user_id=1213'

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

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

req.action_name="baijiankai"
req.agreement_id=23
req.book_id=300000347
req.contract_text="{}"
req.master_id=10143
req.reason="理由"
req.type=1
req.user_id=1213
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.upbookcontract");
add_param(pRequest,"action_name","baijiankai");
add_param(pRequest,"agreement_id","23");
add_param(pRequest,"book_id","300000347");
add_param(pRequest,"contract_text","{}");
add_param(pRequest,"master_id","10143");
add_param(pRequest,"reason","理由");
add_param(pRequest,"type","1");
add_param(pRequest,"user_id","1213");
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.upbookcontract', {
	'action_name':'baijiankai',
	'agreement_id':'23',
	'book_id':'300000347',
	'contract_text':'{}',
	'master_id':'10143',
	'reason':'理由',
	'type':'1',
	'user_id':'1213'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_backendapi_ognvcontract_upbookcontract_response>
    <result>
        <message>ok</message>
        <state>200</state>
    </result>
</alibaba_shuqi_original_backend_backendapi_ognvcontract_upbookcontract_response>

{
    "alibaba_shuqi_original_backend_backendapi_ognvcontract_upbookcontract_response":{
        "result":{
            "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.upbookcontract (书籍主合同、补充合同新增修改接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ