换取授权访问令牌接口 -凯发app官方网站

支持第三方代理调用

更新时间：2024-01-19 14:24:42

订阅更新

我的文档

设置

通用场景

换取授权访问令牌

公共请求参数

参数	类型	是否必选	最大长度	描述	示例值
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[1,20]

【描述】授权方式

【枚举值】

用授权码来换取授权令牌: authorization_code

用刷新令牌来换取一个新的授权令牌: refresh_token

【示例值】authorization_code

code｜授权码可选string[0,40]

【描述】授权码，用户对应用授权后得到。本参数在 grant_type 为 authorization_code 时必填；为 refresh_token 时不填。

【示例值】4b203fe6c11548bcabd8da5bb087a83b

refresh_token｜刷新令牌可选string[0,40]

【描述】刷新令牌，上次换取访问令牌时得到。本参数在 grant_type 为 authorization_code 时不填；为 refresh_token 时必填，且该值来源于此接口的返回值 app_refresh_token（即至少需要通过 grant_type=authorization_code 调用此接口一次才能获取）。

【示例值】201208134b203fe6c11548bcabd8da5bb087a83b

参数中文名	参数英文名	类型	是否必选	长度/取值	描述	示例值
授权方式	grant_type	string	必选	长度范围：[1,20]	授权方式枚举值用授权码来换取授权令牌: authorization_code 用刷新令牌来换取一个新的授权令牌: refresh_token	authorization_code
授权码	code	string	可选	长度范围：[0,40]	授权码，用户对应用授权后得到。本参数在 grant_type 为 authorization_code 时必填；为 refresh_token 时不填。	4b203fe6c11548bcabd8da5bb087a83b
刷新令牌	refresh_token	string	可选	长度范围：[0,40]	刷新令牌，上次换取访问令牌时得到。本参数在 grant_type 为 authorization_code 时不填；为 refresh_token 时必填，且该值来源于此接口的返回值 app_refresh_token（即至少需要通过 grant_type=authorization_code 调用此接口一次才能获取）。	201208134b203fe6c11548bcabd8da5bb087a83b

常见请求示例

默认示例

curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.system.oauth.token&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
 -f 'refresh_token=201208134b203fe6c11548bcabd8da5bb087a83b' \
 -f 'code=4b203fe6c11548bcabd8da5bb087a83b' \
 -f 'grant_type=authorization_code'

说明：本示例仅供参考。

公共响应参数

参数	类型	是否必选	最大长度	描述	示例值
code	string	必选	-	网关返回码,	40004
msg	string	必选	-	网关返回码描述,	business failed
sub_code	string	可选	-	业务返回码，参见具体的api接口文档	acq.trade_has_success
sub_msg	string	可选	-	业务返回码描述，参见具体的api接口文档	交易已被支付
sign	string	必选	-	签名,	dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=

业务响应参数

access_token｜访问令牌必选string(40)

【描述】访问令牌。通过该令牌调用需要授权类接口

【示例值】20120823ac6ffaa4d2d84e7384bf983531473993

expires_in｜访问令牌有效期必选string(16)

【描述】访问令牌的有效时间，单位是秒。

【示例值】3600

refresh_token｜刷新令牌必选string(40)

【描述】刷新令牌。通过该令牌可以刷新access_token

【示例值】20120823ac6ffdsdf2d84e7384bf983531473993

re_expires_in｜刷新令牌有效时间必选string(16)

【描述】刷新令牌的有效时间，单位是秒。

【示例值】3600

以下参数二选一

user_id｜支付宝用户的唯一标识。以2088开头的16位数字。string(16)

【描述】支付宝用户的唯一标识。以2088开头的16位数字。

新商户建议使用open_id替代该字段。对于新商户，user_id字段未来计划逐步回收，存量商户可继续使用。如使用open_id，请确认应用-开发配置-openid配置管理已启用。无该配置项，可查看openid配置申请。

【示例值】2088102150477652

open_id｜支付宝用户唯一标识string(128)

【描述】支付宝用户唯一标识详情可查看 openid简介

【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5

auth_start｜授权开始时间可选date(32)

【描述】授权token开始时间，作为有效期计算的起点

【示例值】2010-11-11 11:11:11

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
支付宝用户的唯一标识。以2088开头的16位数字。	user_id	string	二选一	16	支付宝用户的唯一标识。以2088开头的16位数字。新商户建议使用open_id替代该字段。对于新商户，user_id字段未来计划逐步回收，存量商户可继续使用。如使用open_id，请确认应用-开发配置-openid配置管理已启用。无该配置项，可查看openid配置申请。	2088102150477652
支付宝用户唯一标识	open_id	string	128	支付宝用户唯一标识详情可查看 openid简介	074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
访问令牌	access_token	string	必选	40	访问令牌。通过该令牌调用需要授权类接口	20120823ac6ffaa4d2d84e7384bf983531473993
访问令牌有效期	expires_in	string	必选	16	访问令牌的有效时间，单位是秒。	3600
刷新令牌	refresh_token	string	必选	40	刷新令牌。通过该令牌可以刷新access_token	20120823ac6ffdsdf2d84e7384bf983531473993
刷新令牌有效时间	re_expires_in	string	必选	16	刷新令牌的有效时间，单位是秒。	3600
授权开始时间	auth_start	date	可选	32	授权token开始时间，作为有效期计算的起点	2010-11-11 11:11:11

响应示例

正常示例

异常示例

{
    "alipay_system_oauth_token_response": {
        "user_id": "2088102150477652",
        "open_id": "074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
        "access_token": "20120823ac6ffaa4d2d84e7384bf983531473993",
        "expires_in": "3600",
        "refresh_token": "20120823ac6ffdsdf2d84e7384bf983531473993",
        "re_expires_in": "3600",
        "auth_start": "2010-11-11 11:11:11"
    },
    "sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}