淘宝开放平台

请求地址：

环境	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	可选	300000346	book_id
reason	String	可选	推荐签约	reason
sign_type	Number	可选	30	sign_type
type	Number	可选	0	type
is_async	Number	可选	1	是否采用异步方式 0:否 1:是
unique_class	Number	可选	0	0非特色品类 1是特色品类

名称	类型	示例值	描述
result	CommonResponse	result	result
└ message String ok message └ state Number 200 state data SignOptResp data └ async_task_id String 123123123123 asyncTaskId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvalibookSignoptRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvalibookSignoptRequest();
req.setActionName("baijiankai");
req.setBookId(300000346L);
req.setReason("推荐签约");
req.setSignType(30L);
req.setType(0L);
req.setIsAsync(1L);
req.setUniqueClass(0L);
AlibabaShuqiOriginalBackendBackendapiOgnvalibookSignoptResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendBackendapiOgnvalibookSignoptRequest req = new AlibabaShuqiOriginalBackendBackendapiOgnvalibookSignoptRequest();
req.ActionName = "baijiankai";
req.BookId = 300000346L;
req.Reason = "推荐签约";
req.SignType = 30L;
req.Type = 0L;
req.IsAsync = 1L;
req.UniqueClass = 0L;
AlibabaShuqiOriginalBackendBackendapiOgnvalibookSignoptResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendBackendapiOgnvalibookSignoptRequest;
$req->setActionName("baijiankai");
$req->setBookId("300000346");
$req->setReason("推荐签约");
$req->setSignType("30");
$req->setType("0");
$req->setIsAsync("1");
$req->setUniqueClass("0");
$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.ognvalibook.signopt' \
-d 'partner_id=apidoc' \
-d 'sign=7E6DC8A1FE0E73A9FE5DAD6DFB16C0BD' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A49%3A14' \
-d 'v=2.0' \
-d 'action_name=baijiankai' \
-d 'book_id=300000346' \
-d 'is_async=1' \
-d 'reason=%E6%8E%A8%E8%8D%90%E7%AD%BE%E7%BA%A6' \
-d 'sign_type=30' \
-d 'type=0' \
-d 'unique_class=0'

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

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

req.action_name="baijiankai"
req.book_id=300000346
req.reason="推荐签约"
req.sign_type=30
req.type=0
req.is_async=1
req.unique_class=0
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.ognvalibook.signopt");
add_param(pRequest,"action_name","baijiankai");
add_param(pRequest,"book_id","300000346");
add_param(pRequest,"reason","推荐签约");
add_param(pRequest,"sign_type","30");
add_param(pRequest,"type","0");
add_param(pRequest,"is_async","1");
add_param(pRequest,"unique_class","0");
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.ognvalibook.signopt', {
	'action_name':'baijiankai',
	'book_id':'300000346',
	'reason':'推荐签约',
	'sign_type':'30',
	'type':'0',
	'is_async':'1',
	'unique_class':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_backendapi_ognvalibook_signopt_response>
    <result>
        <message>ok</message>
        <state>200</state>
        <data>
            <async_task_id>123123123123</async_task_id>
        </data>
    </result>
</alibaba_shuqi_original_backend_backendapi_ognvalibook_signopt_response>

{
    "alibaba_shuqi_original_backend_backendapi_ognvalibook_signopt_response":{
        "result":{
            "message":"ok",
            "state":200,
            "data":{
                "async_task_id":"123123123123"
            }
        }
    }
}

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.ognvalibook.signopt (签约状态变更)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ