版本：V3.0

授權認證API

授權碼模式-獲取授權碼

接口地址

GET /api/v1.0/invoke/open-ability/method/oauth2/auth

請求參數

參數名	類型	位置	必填	說明
scope	String	Query	是	授權範圍，值爲user
state	String	Query	是	客戶端狀態
redirect_uri	String	Query	是	重定向地址
response_type	String	Query	是	應答類型，值爲code
client_id	String	Query	是	客戶端ID

返回參數

參數名	類型	位置	說明
state	String	Query	客戶端狀態，與入參一致
code	String	Query	授權碼

請求示例

GET /api/v1.0/invoke/open-ability/method/oauth2/auth?scope=user&state=1&response_type=code&client_id=caa0b4dffd57202a157bf46664f93c192&redirect_uri=https://demo.akubela.com

成功返回示例

https://demo.akubela.com?state=1&code=cb66a21f7d9fe1a141676a563c5a7eacf

失敗返回示例

無

授權碼模式-獲取訪問令牌

接口地址

POST /api/v1.0/invoke/open-ability/method/oauth2/token

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/x-www-form-urlencoded
Accept	String	Header	是	接受類型，值爲application/json
grant_type	String	Body	是	授權類型，值爲authorization_code
code	String	Body	是	授權碼
client_id	String	Body	是	客戶端ID
client_secret	String	Body	是	客戶端密鑰
redirect_uri	String	Body	是	重定向地址
expires_in	Integer	Body	否	令牌過期時間，單位：秒

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
access_token	String	Body	訪問令牌
refresh_token	String	Body	刷新令牌
token_type	String	Body	令牌類型，值爲bearer
expires_in	Integer	Body	令牌過期時間，單位：秒

請求示例

POST /api/v1.0/invoke/open-ability/method/oauth2/token

Content-Type: application/x-www-form-urlencoded

Accept: application/json

grant_type=authorization_code&

code=cb66a21f7d9fe1a141676a563c5a7eacf&

client_id=caa0b4dffd57202a157bf46664f93c192&

client_secret=s75b058bfd9e4e0659d75b67a03334745&

redirect_uri=https://demo.akubela.com

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_token": "ad5db2a3d3ab09e5890c4ffba9eaf3c55",
    "refresh_token": "r91b9ba8bc024e23617f63f908dc15950",
    "token_type": "bearer",
    "expires_in": 3600
  }
}

失敗返回示例

見接口失敗返回

密碼模式-獲取訪問令牌

接口地址

POST /api/v1.0/invoke/open-ability/method/oauth2/token

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/x-www-form-urlencoded
Accept	String	Header	是	接受類型，值爲application/json
grant_type	String	Body	是	授權類型，值爲password
client_id	String	Body	是	客戶端ID
client_secret	String	Body	是	客戶端密鑰
scope	String	Body	是	授權範圍，值爲user
username	String	Body	是	賬號
password	String	Body	是	密碼
expires_in	Integer	Body	否	令牌過期時間，單位：秒

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
access_token	String	Body	訪問令牌
refresh_token	String	Body	刷新令牌
token_type	String	Body	令牌類型，值爲bearer
expires_in	Integer	Body	令牌過期時間，單位：秒

請求示例

POST /api/v1.0/invoke/open-ability/method/oauth2/token

Content-Type: application/x-www-form-urlencoded

Accept: application/json

grant_type=password&

client_id=caa0b4dffd57202a157bf46664f93c192&

client_secret=s75b058bfd9e4e0659d75b67a03334745&

username=ucaa0b4dffd57202a157bf46664f93c19&

password=pucaa0b4dffd57202a157bf46664f93c1&

scope=user

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_token": "ad5db2a3d3ab09e5890c4ffba9eaf3c55",
    "refresh_token": "r91b9ba8bc024e23617f63f908dc15950",
    "token_type": "bearer",
    "expires_in": 3600
  }
}

失敗返回示例

見接口失敗返回

刷新訪問令牌

接口地址

POST /api/v1.0/invoke/open-ability/method/oauth2/token

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/x-www-form-urlencoded
Accept	String	Header	是	接受類型，值爲application/json
grant_type	String	Body	是	授權類型，值爲refresh_token
client_id	String	Body	是	客戶端ID
client_secret	String	Body	是	客戶端密鑰
refresh_token	String	Body	是	刷新令牌
expires_in	Integer	Body	否	令牌過期時間，單位：秒

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
access_token	String	Body	訪問令牌
refresh_token	String	Body	刷新令牌
token_type	String	Body	令牌類型，值爲bearer
expires_in	Integer	Body	令牌過期時間，單位：秒

請求示例

POST /api/v1.0/invoke/open-ability/method/oauth2/token

Content-Type: application/x-www-form-urlencoded

Accept: application/json

grant_type=refresh_token&

client_id=caa0b4dffd57202a157bf46664f93c192&

client_secret=s75b058bfd9e4e0659d75b67a03334745&

refresh_token=r91b9ba8bc024e23617f63f908dc15950

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_token": "ad5db2a3d3ab09e5890c4ffba9eaf3c53",
    "refresh_token": "r91b9ba8bc024e23617f63f908dc15952",
    "token_type": "bearer",
    "expires_in": 3600
  }
}

失敗返回示例

見接口失敗返回

授權碼模式-獲取授權碼​

接口地址​

請求參數​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

授權碼模式-獲取訪問令牌​

接口地址​

請求參數​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

密碼模式-獲取訪問令牌​

接口地址​

請求參數​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

刷新訪問令牌​

接口地址​

請求參數​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

授權碼模式-獲取授權碼

接口地址

請求參數

返回參數

請求示例

成功返回示例

失敗返回示例

授權碼模式-獲取訪問令牌

接口地址

請求參數

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

密碼模式-獲取訪問令牌

接口地址

請求參數

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

刷新訪問令牌

接口地址

請求參數

返回參數

result說明

請求示例

成功返回示例

失敗返回示例