获取AccessToken
功能介绍
获取Access Token,Access Token可用于调用获取用户信息API。
接口约束
无
URI
POST /api/v1/oauth2/token
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
code |
是 |
String |
授权码,认证登录获取授权码接口返回的授权码。 |
client_id |
是 |
String |
应用标识,注册应用后,分配的ClientId。 |
client_secret |
是 |
String |
应用密钥,注册应用后,分配的ClientSecret。 |
grant_type |
是 |
String |
授权类型,固定值:authorization_code。 |
redirect_uri |
否 |
String |
回调地址,地址可以是注册应用时填写的回调地址,也可以是注册应用时填写的回调地址的域名。若传入,则需要与调用认证登录获取授权码接口的入参redirect_url保持一致。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
access_token |
String |
授权服务器返回给第三方应用的访问令牌。 |
token_type |
String |
访问令牌类型。固定值:Bearer。 |
expires_in |
Long |
访问令牌的有效期,以秒为单位。 |
scope |
String |
授权范围。 |
refresh_token |
String |
刷新令牌。默认不生成refresh_token,如果需要,在应用的“认证配置”中设置“Refresh Token有效期”后生成返回。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
String |
错误类型。 |
error_description |
String |
错误描述。 |
请求示例
获取AccessToken,后续使用该token获取用户信息。code使用认证登录获取授权码接口返回的授权码z2D...,client_id和client_secert使用注册应用时分配的ClientId和ClientSecret,redirect_uri配置为应用的回调地址https://example.com,grant_type为固定值authorization_code。
POST https://{domain_name}/api/v1/oauth2/token Content-Type: application/x-www-form-urlencoded code=z2D...& client_id=NzZeWuiJa91dPSRdZQChMazIh13AW...& client_secret=NzZeWuiJa91dPSRdZQChMazIh13AW...& redirect_uri=https://example.com& grant_type=authorization_code
响应示例
状态码: 200
请求成功。
{ "access_token" : "NqM******d3k", "token_type" : "Bearer", "expires_in" : "7200", "scope" : "get_user_info", "refresh_token" : "42e******w24" }
状态码: 400
请求错误。
{ "error" : "invalid_grant", "error_description" : "Invalid authorization code" }
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
请求错误。 |
错误码
请参见错误码。