taobao.top.secret.get
获取TOP通道解密秘钥

请求地址

环境 HTTP地址 HTTPS地址 请求方式
正式环境 http://open.ieasynote.com/api https://open.ieasynote.com/api POST

公共参数

参数名 类型 必须 描述
method String API接口名称,例如:taobao.top.secret.get
app_key String TOP分配给应用的AppKey,例如:12345678
session String 用户登录授权成功后,TOP颁发给应用的授权信息,详细介绍请[点击这里]()。当此API的标签上注明:“需要授权”,则此参数必传;“不需要授权”,则此参数不需要传;“可选授权”,则此参数为可选
timestamp String 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8,例如:2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟
v String API协议版本,可选值:2.0
sign_method String 签名的摘要算法,可选值为:hmac,md5,hmac-sha256
sign String API输入参数签名结果,签名算法介绍请[点击这里](
format String 响应格式。默认为xml格式,可选值:xml,json
simplify Boolean 是否采用精简JSON返回格式,仅当format=json时有效,默认值为:false

公共响应参数

公共响应参数中,error_responsexxx_response只会出现一个
参数名 类型 描述
request_id String 平台颁发的每次请求访问的唯一标识
error_response String 请求访问失败时返回的根节点,和 xxxxx_response 只会出现一个
        code String 请求失败返回的错误码,error_response 的子节点
        msg String 请求失败返回的错误信息,error_response 的子节点
        sub_code String 请求失败返回的子错误码,error_response 的子节点
        sub_msg String 请求失败返回的子错误信息,error_response 的子节点
xxxxx_response String 请求成功返回的根节点, 和 error_response 只会出现一个,'xxxxx' 为API名称的下划线模式,本接口为:top_secret_get_response

请求参数

参数名 类型 必须 示例值 描述
secret_version Number 1 秘钥版本号
random_num String 0ebbcccfee18d7ad1aebc5b875ffa906 伪随机数
customer_user_id Number 1111111 自定义用户id

请求响应参数

请求响应参数是 xxx_response 的子节点
参数名 类型 示例值 描述
interval Number 900 下次更新秘钥间隔,单位(秒)
max_interval Number 1800 最长有效期,容灾使用,单位(秒)
secret String 0ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa906 秘钥值
secret_version Number 1 秘钥版本号
app_config String {"current_phone","2"} app配置信息

请求示例代码

将接口地址URL设置成: http://open.ieasynote.com/api
                        
                        
$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TopSecretGetRequest;
$req->setSecretVersion("1");
$req->setRandomNum("0ebbcccfee18d7ad1aebc5b875ffa906");
$req->setCustomerUserId("1111111");
$resp = $c->execute($req, $sessionKey);
                                
                    
                        
                        
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopSecretGetRequest req = new TopSecretGetRequest();
req.setSecretVersion(1L);
req.setRandomNum("0ebbcccfee18d7ad1aebc5b875ffa906");
req.setCustomerUserId(1111111L);
TopSecretGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());
                                
                    
                        
                        
ITopClient client = new DefaultTopClient(url, appkey, secret);
TopSecretGetRequest req = new TopSecretGetRequest();
req.SecretVersion = 1L;
req.RandomNum = "0ebbcccfee18d7ad1aebc5b875ffa906";
req.CustomerUserId = 1111111L;
TopSecretGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);
                                
                    
                        
                        
# -*- coding: utf-8 -*-
import top.api

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

req.secret_version=1
req.random_num="0ebbcccfee18d7ad1aebc5b875ffa906"
req.customer_user_id=1111111
try:
    resp= req.getResponse(sessionkey)
    print(resp)
except Exception,e:
    print(e)
                                
                    
                        
                        
curl -X POST 'http://open.ieasynote.com/api' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.top.secret.get' \
-d 'partner_id=apidoc' \
-d 'session=2eb54152-5c20-47d6-81a4-daaf19d70b65' \
-d 'sign=69CB3BC8C5D1DDC447E6AD40A2481773' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-08-24+11%3A35%3A20' \
-d 'v=2.0' \
-d 'customer_user_id=1111111' \
-d 'random_num=0ebbcccfee18d7ad1aebc5b875ffa906' \
-d 'secret_version=1'
                                
                    
                        
                        
TopClient = require('./topClient').TopClient;
var client = new TopClient({
    'appkey': 'appkey',
    'appsecret': 'secret',
    'REST_URL': 'http://open.ieasynote.com/api'
});

client.execute('taobao.top.secret.get', {
    'secret_version':'1',
    'random_num':'0ebbcccfee18d7ad1aebc5b875ffa906',
    'customer_user_id':'1111111'
}, function(error, response) {
    if (!error) console.log(response);
    else console.log(error);
})
                                
                    
                        
                        
package main;

import (
    "fmt"
    "topsdk"
    "topsdk/ability304"
    "topsdk/ability304/request"
)

func main() {
    client := topsdk.NewDefaultTopClient("<your-appkey>","<your-appsecret>","<top-gateway-url>",20000,20000)
    ability := ability304.NewAbility304(&client)


    req := request.TaobaoTopSecretGetRequest{}
    req.SetSecretVersion(1)
    req.SetRandomNum("0ebbcccfee18d7ad1aebc5b875ffa906")
    req.SetCustomerUserId(1111111)


    resp, err := ability.TaobaoTopSecretGet(&req)
    if(err != nil) {
        fmt.Println(err)
    } else {
        fmt.Println(resp.Body)
    }
}
                                
                    
                        
                        
<?php
require "../vendor/autoload.php";
use Topsdk\Topapi\TopApiClient;
use Topsdk\Topapi\Ability304\Request\TaobaoTopSecretGetRequest;
use Topsdk\Topapi\Ability304\Ability304;


// create Client
$client = new TopApiClient("<your-appkey>","<your-appsecret>","<top-gateway-url>");
$ability = new Ability304($client);

// create domain

// create request
$request = new TaobaoTopSecretGetRequest();
$request->setSecretVersion(1);
$request->setRandomNum("0ebbcccfee18d7ad1aebc5b875ffa906");
$request->setCustomerUserId(1111111);

$response = $ability->taobaoTopSecretGet($request);
var_dump($response);
                            
                    
                        
                        
import com.alibaba.fastjson.JSON;
import java.io.File;
import java.util.ArrayList;
import java.util.Date;
import com.taobao.top.TopApiClient;
import com.taobao.top.DefaultTopApiClient;
import com.taobao.top.TopFileItem;
import com.taobao.top.ability304.Ability304;
import com.taobao.top.ability304.request.TaobaoTopSecretGetRequest;
import com.taobao.top.ability304.response.TaobaoTopSecretGetResponse;

public class Main {

    public static void main(String[] args) throws Exception {
        // create Client
        TopApiClient client = new DefaultTopApiClient("<your-appkey>","<your-appsecret>","<top-gateway-url>");
        Ability304 apiPackage = new Ability304(client);
        // create domain

        // create request
        TaobaoTopSecretGetRequest request = new TaobaoTopSecretGetRequest();
        request.setSecretVersion(1);
        request.setRandomNum("0ebbcccfee18d7ad1aebc5b875ffa906");
        request.setCustomerUserId(1111111);

        TaobaoTopSecretGetResponse response = apiPackage.taobaoTopSecretGet(request);
        if(!response.isSuccess()){
            System.out.println(response.getSubMsg());
        }
        System.out.println(JSON.toJSONString(response));
    }
}
                            
                    

响应示例

                        
                                                
                    
                        
                        
{
    "error_response":{
        "msg":"Remote service error",
        "code":50,
        "sub_msg":"非法参数",
        "sub_code":"isv.invalid-parameter"
    }
}
                                
                    

异常响应示例

                        
                            
<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":"XXX",
        "sub_code":"isv.invalid-parameter"
    }
}
                            
                    

错误码描述

错误码 错误消息 解决方案
暂无错误解释