alipay.system.oauth.token(换取授权访问令牌)
[TOC]
支持第三方代理调用
换取授权访问令牌
公共参数
请求地址
公共请求参数
参数 |
类型 |
是否必填 |
最大长度 |
描述 |
示例值 |
app_id |
String |
是 |
32 |
支付宝分配给开发者的应用ID |
2014072300007148 |
method |
String |
是 |
128 |
接口名称 |
alipay.system.oauth.token |
format |
String |
否 |
40 |
仅支持JSON |
JSON |
charset |
String |
是 |
10 |
请求使用的编码格式,如utf-8,gbk,gb2312等 |
utf-8 |
sign_type |
String |
是 |
10 |
商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 |
RSA2 |
sign |
String |
是 |
344 |
商户请求参数的签名串,详见签名 |
详见示例 |
timestamp |
String |
是 |
19 |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
2014-07-24 03:07:50 |
version |
String |
是 |
3 |
调用的接口版本,固定为:1.0 |
1.0 |
app_auth_token |
String |
否 |
40 |
详见应用授权概述 |
请求参数
参数 |
类型 |
是否必填 |
最大长度 |
描述 |
grant_type |
String |
是 |
- |
值为authorization_code时,代表用code换取;值为refresh_token时,代表用refresh_token换取 |
code |
String |
可选 |
- |
授权码,用户对应用授权后得到。 |
refresh_token |
String |
可选 |
- |
刷刷新令牌,上次换取访问令牌时得到。见出参的refresh_token字段 |
响应参数
参数 |
类型 |
是否必填 |
最大长度 |
描述 |
示例值 |
user_id |
String |
必填 |
16 |
支付宝用户的唯一userId |
2088102150477652 |
access_token |
String |
必填 |
40 |
访问令牌。通过该令牌调用需要授权类接口 |
20120823ac6ffaa4d2d84e7384bf983531473993 |
expires_in |
String |
必填 |
16 |
访问令牌的有效时间,单位是秒。 |
3600 |
refresh_token |
String |
必填 |
40 |
刷新令牌。通过该令牌可以刷新access_token |
20120823ac6ffdsdf2d84e7384bf983531473993 |
re_expires_in |
String |
必填 |
16 |
刷新令牌的有效时间,单位是秒。 |
3600 |
请求示例
JAVA
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipaySystemOauthTokenRequest request = new AlipaySystemOauthTokenRequest();
request.setGrantType("authorization_code");
request.setCode("4b203fe6c11548bcabd8da5bb087a83b");
request.setRefreshToken("201208134b203fe6c11548bcabd8da5bb087a83b");
AlipaySystemOauthTokenResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
.NET
IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "app_id", "merchant_private_key", "json", "1.0", "RSA2", "alipay_public_key", "GBK", false);
AlipaySystemOauthTokenRequest request= new AlipaySystemOauthTokenRequest() ;
request.GrantType = "authorization_code";
request.Code = "4b203fe6c11548bcabd8da5bb087a83b";
request.RefreshToken = "201208134b203fe6c11548bcabd8da5bb087a83b";
AlipaySystemOauthTokenResponse response=client.execute(request);
Console.WriteLine(response.Body);
PHP
$aop = new AopClient ();
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do';
$aop->appId = 'your app_id';
$aop->rsaPrivateKey = '请填写开发者私钥去头去尾去回车,一行字符串';
$aop->alipayrsaPublicKey='请填写支付宝公钥,一行字符串';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset='GBK';
$aop->format='json';
$request = new AlipaySystemOauthTokenRequest ();
$request->setGrantType("authorization_code");
$request->setCode("4b203fe6c11548bcabd8da5bb087a83b");
$request->setRefreshToken("201208134b203fe6c11548bcabd8da5bb087a83b");
$result = $aop->execute ( $request);
$responseNode = str_replace(".", "_", $request->getApiMethodName()) . "_response";
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
echo "成功";
} else {
echo "失败";
}
HTTP请求源码
https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=alipay.system.oauth.token&app_id=4472&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&grant_type=
"authorization_code"
&code=
"4b203fe6c11548bcabd8da5bb087a83b"
&refresh_token=
"201208134b203fe6c11548bcabd8da5bb087a83b"
//为确保安全通信,需自行验证响应示例中的sign值是否为蚂蚁金服所提供。
响应示例
JSON 示例
{
"alipay_system_oauth_token_response": {
"user_id": "2088102150477652",
"access_token": "20120823ac6ffaa4d2d84e7384bf983531473993",
"expires_in": "3600",
"refresh_token": "20120823ac6ffdsdf2d84e7384bf983531473993",
"re_expires_in": "3600"
}
}
XML 示例
10000
Success 已废弃,请勿使用
2088102150477652
20120823ac6ffaa4d2d84e7384bf983531473993
3600
20120823ac6ffdsdf2d84e7384bf983531473993
3600
permanent
异常示例
JSON 示例
{
"alipay_system_oauth_token_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
业务错误码
公共错误码
错误码 |
错误描述 |
解决方案 |
isv.grant-type-invalid |
grant_type参数不正确 |
grant_type必须是authorization_code、refresh_token二者之一 若传入authorization_code为code换取令牌,若传入refresh_token为刷新令牌 |
isv.code-invalid |
授权码(auth_code) 错误、状态不对或过期 |
使用有效的auth_code重新执行令牌换取,或引导用户重新授权 |
isv.refresh-token-invalid |
刷新令牌(refresh_token)错误或状态不对 |
使用有效的refresh_token重新执行令牌刷新,或引导用户重新授权 |
isv.refresh-token-time-out |
刷新令牌(refresh_token)过期 |
使用有效的refresh_token重新执行令牌刷新,或引导用户重新授权 |
isv.refreshed-token-invalid |
刷新出来的令牌无效 |
使用返回的刷新令牌再次刷新 |
isv.invalid-app-id |
调用接口的应用标识(app_id)与令牌授权的应用不相符 |
传入正确的app_id和令牌,若开发者支付宝账号名下有多个app_id,或者开发者管理多个归属于不同支付宝账号的app_id,请注意不要混用不同app_id的code |
isp.unknow-error |
未知错误 |
重试,或联系支付宝客服 |