taobao.top.auth.token.create
获取Access Token
请求地址
| 环境 | HTTP地址 | HTTPS地址 | 请求方式 |
|---|---|---|---|
| 正式环境 | http://open.ieasynote.com/api | https://open.ieasynote.com/api | POST |
公共参数
| 参数名 | 类型 | 必须 | 描述 |
|---|---|---|---|
| method | String | 是 | API接口名称，例如:taobao.top.auth.token.create |
| 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_response 和 xxx_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_auth_token_create_response |
请求参数
| 参数名 | 类型 | 必须 | 示例值 | 描述 |
|---|---|---|---|---|
| code | String | 是 | 0AebKlCPqc6OD8RBlB0DzfnpUg2 | 授权code，grant_type=authorization_code 时需要 |
请求响应参数
请求响应参数是 xxx_response 的子节点
| 参数名 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| token_result | Json | |
返回的是json信息，和之前调用https://open.ieasynote.com/token 换token返回的字段信息一致 |
请求示例代码
将接口地址URL设置成: http://open.ieasynote.com/api
$c = new TopClient;
// WARN: url: http://open.ieasynote.com/api
$c->gatewayUrl = "http://open.ieasynote.com/api";
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TopAuthTokenCreateRequest;
$req->setCode("0_ebKlCPqc6OD8RBlB0DzfnpUg2");
$req->setUuid("abc");
$resp = $c->execute($req);
// WARN: url: http://open.ieasynote.com/api
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopAuthTokenCreateRequest req = new TopAuthTokenCreateRequest();
req.setCode("0_ebKlCPqc6OD8RBlB0DzfnpUg2");
req.setUuid("abc");
TopAuthTokenCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());
// WARN: url: http://open.ieasynote.com/api
ITopClient client = new DefaultTopClient(url, appkey, secret);
TopAuthTokenCreateRequest req = new TopAuthTokenCreateRequest();
req.Code = "0_ebKlCPqc6OD8RBlB0DzfnpUg2";
req.Uuid = "abc";
TopAuthTokenCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);
# -*- coding: utf-8 -*-
import top.api
# WARN: url: http://open.ieasynote.com/api
req=top.api.TopAuthTokenCreateRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))
req.code="0_ebKlCPqc6OD8RBlB0DzfnpUg2"
req.uuid="abc"
try:
resp= req.getResponse()
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.auth.token.create' \
-d 'partner_id=apidoc' \
-d 'sign=EA4A9003AB6C02F818D5CF9BC4521CF3' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-08-21+23%3A59%3A41' \
-d 'v=2.0' \
-d 'code=0_ebKlCPqc6OD8RBlB0DzfnpUg2' \
-d 'uuid=abc'
TopClient = require('./topClient').TopClient;
var client = new TopClient({
'appkey': 'appkey',
'appsecret': 'secret',
'REST_URL': 'http://open.ieasynote.com/api'
});
client.execute('taobao.top.auth.token.create', {
'code':'0_ebKlCPqc6OD8RBlB0DzfnpUg2',
'uuid':'abc'
}, function(error, response) {
if (!error) console.log(response);
else console.log(error);
})
package main;
import (
"fmt"
"topsdk"
"topsdk/ability304"
"topsdk/ability304/request"
)
func main() {
// WARN: url: http://open.ieasynote.com/api
client := topsdk.NewDefaultTopClient("<your-appkey>","<your-appsecret>","http://open.ieasynote.com/api",20000,20000)
ability := ability304.NewAbility304(&client)
req := request.TaobaoTopAuthTokenCreateRequest{}
req.SetCode("0_ebKlCPqc6OD8RBlB0DzfnpUg2")
req.SetUuid("abc")
resp, err := ability.TaobaoTopAuthTokenCreate(&req)
if(err != nil) {
fmt.Println(err)
} else {
fmt.Println(resp.Body)
}
}
响应示例
<top_auth_token_create_response>
<token_result>{\"w2_valid\":1437127235362,\"r1_valid\":1437129035362,\"sp\":\"tbUIC\",\"r2_valid\":1437127235362,\"w1_valid\":1437129035362,\"locale\":\"zh_CN\",\"user_id\":\"2021891722\",\"expire_time\":1468663236386,\"refresh_token\":\"50003400e34kgvzoweD0nUeMwB0ueXeDQiOVxdkmKpaeVW18619220EhyAKWUVQYqLE2\",\"user_nick\":\"yexue08\",\"refresh_token_valid_time\":1437129035362,\"access_token\":\"50002400834dMShsDmop3NrEfaozeisCSTGAfbuCl0YdKH15967dafOlxfMa3oYlpO2Q\"}", "request_id": "16sd74g5krf9u"}</token_result>
</top_auth_token_create_response>
{
"top_auth_token_create_response":{
"token_result":"{\\"w2_valid\\":1437127235362,\\"r1_valid\\":1437129035362,\\"sp\\":\\"tbUIC\\",\\"r2_valid\\":1437127235362,\\"w1_valid\\":1437129035362,\\"locale\\":\\"zh_CN\\",\\"user_id\\":\\"2021891722\\",\\"expire_time\\":1468663236386,\\"refresh_token\\":\\"50003400e34kgvzoweD0nUeMwB0ueXeDQiOVxdkmKpaeVW18619220EhyAKWUVQYqLE2\\",\\"user_nick\\":\\"yexue08\\",\\"refresh_token_valid_time\\":1437129035362,\\"access_token\\":\\"50002400834dMShsDmop3NrEfaozeisCSTGAfbuCl0YdKH15967dafOlxfMa3oYlpO2Q\\"}\", \"request_id\": \"16sd74g5krf9u\" }"
}
}
异常响应示例
<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"
}
}
错误码描述
| 错误码 | 错误消息 | 解决方案 |
|---|---|---|
暂无错误解释 |