4. 授权认证接口

4.1. Oauth2.0中授权码模式

  • 用户调用服务器接口,应用服务器通过构造OAuth2链接(参数包括当前第三方服务的身份ID,以及重定向URI),校验当前用户权限。

  • 通过校验后,应用服务器将重定向到用户第一步指定的重定向URI,同时附上一个授权码。

  • 用户收到授权码,带上授权码访问服务器接口,向认证服务器申请凭证。

  • 认证服务器检查授权码及客户端密钥的有效性,通过后颁发AccessToken(调用凭证)用于数据接口的调用。

4.2. 获取Authorization Code接口

调用:/v3/openapi/oauth2/authorize

请求类型:get

请求参数:

参数

必选

类型

默认值

说明

client_id

string

分配的client_id

response_type

string

code

响应类型,此值固定为”code”

redirect_uri

string

获取授权码后回调的url

1)调用此接口成功后,会把code参数放在回调url地址上。类似“https://liveadmin.tusuav.com/oauth_redirect?code=0987654321

2)每一个Authorization Code只能使用一次且有效期为60s,再次使用将无效。

4.3. 通过Authorization Code获取Access Token接口

调用:/v3/openapi/oauth2/accessToken

请求类型:post

请求参数:

参数

必选

类型

默认值

说明

client_id

string

分配的client_id

grant_type

string

authorization_code

响应类型,此值固定

code

string

上一步获取的authorization_code

client_secret

string

分配的client_secret

返回示例:
{
"status": 1,
"tips": "操作成功",
"data": {
    "access_token": "87ffe5741f9f178fda51434e6a9d6645",
    "refresh_token": "efb87014d744202838037509cf98221e",
    "expires_in": 7200
    }
}

返回说明:

参数名

类型

说明

status

string

tips

string

data

array

access_token

string

调用凭证,用于数据接口的调用。

expires_in

string

expires_in:凭证有效时间(秒)。

refresh_token

string

用于刷新access_token的凭证

4.4. 刷新Access Token接口

调用:/v3/openapi/oauth2/refreshToken

请求类型:post

请求参数:

参数

必选

类型

默认值

说明

client_id

string

分配的client_id

grant_type

string

refresh_token

响应类型,此值固定

refresh_token

string

用于刷新Access Token用的Refresh Token

client_secret

string

分配的client_secret

返回示例:
{
"status": 1,
"tips": "操作成功",
"data": {
    "access_token": "87ffe5741f9f178fda51434e6a9d6645",
    "expires_in": 7200
    }
}

返回说明:

参数名

类型

说明

status

string

tips

string

data

array

access_token

string

调用凭证,用于数据接口的调用。

expires_in

string

expires_in:凭证有效时间(秒)。