淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
agreement_id	Number	可选	1	agreementId
action_name	String	可选	1	actionName
book_id	Number	可选	1	bookId

名称	类型	示例值	描述
result	CommonResponse	1	result
data_list LongBookSignListResp [] 1 data └ sign_type Number 1 signType └ ext String 1 ext └ before_sign_type Number 1 beforeSignType └ agreement_id Number 1 agreementId └ book_id Number 1 bookId └ id Number 1 id └ opt_time String 1 optTime └ opt_name String 1 optName └ reason String 1 reason └ sign_type_show String 1 signTypeShow └ state Number 1 state └ message String 1 message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOgnvalibookSignlistRequest req = new AlibabaShuqiOriginalBackendOgnvalibookSignlistRequest();
req.setAgreementId(1L);
req.setActionName("1");
req.setBookId(1L);
AlibabaShuqiOriginalBackendOgnvalibookSignlistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOgnvalibookSignlistRequest req = new AlibabaShuqiOriginalBackendOgnvalibookSignlistRequest();
req.AgreementId = 1L;
req.ActionName = "1";
req.BookId = 1L;
AlibabaShuqiOriginalBackendOgnvalibookSignlistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendOgnvalibookSignlistRequest;
$req->setAgreementId("1");
$req->setActionName("1");
$req->setBookId("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.ognvalibook.signlist' \
-d 'partner_id=apidoc' \
-d 'sign=2D2F676355F20F70CE1A917B4D837466' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A47%3A47' \
-d 'v=2.0' \
-d 'action_name=1' \
-d 'agreement_id=1' \
-d 'book_id=1'

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

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

req.agreement_id=1
req.action_name="1"
req.book_id=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.ognvalibook.signlist");
add_param(pRequest,"agreement_id","1");
add_param(pRequest,"action_name","1");
add_param(pRequest,"book_id","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.ognvalibook.signlist', {
	'agreement_id':'1',
	'action_name':'1',
	'book_id':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_ognvalibook_signlist_response>
    <result>
        <data_list>
            <long_book_sign_list_resp>
                <sign_type>1</sign_type>
                <ext>1</ext>
                <before_sign_type>1</before_sign_type>
                <agreement_id>1</agreement_id>
                <book_id>1</book_id>
                <id>1</id>
                <opt_time>1</opt_time>
                <opt_name>1</opt_name>
                <reason>1</reason>
                <sign_type_show>1</sign_type_show>
            </long_book_sign_list_resp>
        </data_list>
        <state>1</state>
        <message>1</message>
    </result>
</alibaba_shuqi_original_backend_ognvalibook_signlist_response>

{
    "alibaba_shuqi_original_backend_ognvalibook_signlist_response":{
        "result":{
            "data_list":{
                "long_book_sign_list_resp":[
                    {
                        "sign_type":1,
                        "ext":"1",
                        "before_sign_type":1,
                        "agreement_id":1,
                        "book_id":1,
                        "id":1,
                        "opt_time":"1",
                        "opt_name":"1",
                        "reason":"1",
                        "sign_type_show":"1"
                    }
                ]
            },
            "state":1,
            "message":"1"
        }
    }
}

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.ognvalibook.signlist (签约板块-操作日志列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ