阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	描述
alipay_context	String	必须	{ "masterId": "1", "havanaNick": "1", "loginId": "1", "havanaId": "1"}	支付宝请求上下文
req	DocDetailRequest	必须		系统自动生成
└ doc_id Number 必须 80 api主键 └ type String 必须 api 文档类型

名称	类型	示例值	描述
result	Result		接口返回model
result Result 接口返回model details Detail [] [] 接口返回model └ code String baseInfo code └ name String 基础信息名称 └ html String html └ type String base 类型 childrens Children [] 子数据 └ code String exampleCode 代码块名字 └ name String CODE 自定义，不能重复，切换tab时用的key └ html String <div> </div> 实例代码的html └ title String my.getSystemInfo 标题 └ success Boolean false 是否成功 └ result_code String 200 返回码 └ result_msg String 成功返回信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YunosMiniappDocDetailGetRequest req = new YunosMiniappDocDetailGetRequest();
req.setAlipayContext("{ \"masterId\": \"1\", \"havanaNick\": \"1\", \"loginId\": \"1\", \"havanaId\": \"1\"}");
YunosMiniappDocDetailGetRequest.DocDetailRequest obj1 = new YunosMiniappDocDetailGetRequest.DocDetailRequest();
obj1.setDocId(80L);
obj1.setType("api");
req.setReq(obj1);
YunosMiniappDocDetailGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
YunosMiniappDocDetailGetRequest req = new YunosMiniappDocDetailGetRequest();
req.AlipayContext = "{ \"masterId\": \"1\", \"havanaNick\": \"1\", \"loginId\": \"1\", \"havanaId\": \"1\"}";
YunosMiniappDocDetailGetRequest.DocDetailRequestDomain obj1 = new YunosMiniappDocDetailGetRequest.DocDetailRequestDomain();
obj1.DocId = 80L;
obj1.Type = "api";
req.Req_ = obj1;
YunosMiniappDocDetailGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new YunosMiniappDocDetailGetRequest;
$req->setAlipayContext("{ \"masterId\": \"1\", \"havanaNick\": \"1\", \"loginId\": \"1\", \"havanaId\": \"1\"}");
$req = new DocDetailRequest;
$req->doc_id="80";
$req->type="api";
$req->setReq(json_encode($req));
$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=yunos.miniapp.doc.detail.get' \
-d 'partner_id=apidoc' \
-d 'sign=C8A6476B53BF7B582834D751D7FECD69' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-08-01+02%3A43%3A44' \
-d 'v=2.0' \
-d 'alipay_context=%7B+%5C%22masterId%5C%22%3A+%5C%221%5C%22%2C+%5C%22havanaNick%5C%22%3A+%5C%221%5C%22%2C+%5C%22loginId%5C%22%3A+%5C%221%5C%22%2C+%5C%22havanaId%5C%22%3A+%5C%221%5C%22%7D' \
-d 'req=null'

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

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

req.alipay_context="{ \"masterId\": \"1\", \"havanaNick\": \"1\", \"loginId\": \"1\", \"havanaId\": \"1\"}"
req.req=""
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,"yunos.miniapp.doc.detail.get");
add_param(pRequest,"alipay_context","{ \"masterId\": \"1\", \"havanaNick\": \"1\", \"loginId\": \"1\", \"havanaId\": \"1\"}");
add_param(pRequest,"req","数据结构JSON示例");
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('yunos.miniapp.doc.detail.get', {
	'alipay_context':'{ \"masterId\": \"1\", \"havanaNick\": \"1\", \"loginId\": \"1\", \"havanaId\": \"1\"}',
	'req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<yunos_miniapp_doc_detail_get_response>
    <result>
        <result>
            <details>
                <detail>
                    <code>baseInfo</code>
                    <name>基础信息</name>
                    <html></html>
                    <type>base</type>
                    <childrens>
                        <children>
                            <code>exampleCode</code>
                            <name>CODE</name>
                            <html>&lt;div&gt; &lt;/div&gt;</html>
                        </children>
                    </childrens>
                </detail>
            </details>
            <title>my.getSystemInfo</title>
        </result>
        <success>false</success>
        <result_code>200</result_code>
        <result_msg>成功</result_msg>
    </result>
</yunos_miniapp_doc_detail_get_response>

{
    "yunos_miniapp_doc_detail_get_response":{
        "result":{
            "result":{
                "details":{
                    "detail":[
                        {
                            "code":"baseInfo",
                            "name":"基础信息",
                            "html":"",
                            "type":"base",
                            "childrens":{
                                "children":[
                                    {
                                        "code":"exampleCode",
                                        "name":"CODE",
                                        "html":"<div> <\/div>"
                                    }
                                ]
                            }
                        }
                    ]
                },
                "title":"my.getSystemInfo"
            },
            "success":false,
            "result_code":"200",
            "result_msg":"成功"
        }
    }
}

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下载

小程序API

yunos.miniapp.doc.detail.get (获取文档详细信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈