7x31/SOP
1
0
Fork 0
mirror of https://gitee.com/durcframework/SOP.git synced 2025-08-11 12:56:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

新增应用授权

Browse Source
This commit is contained in:
tanghc
2019-04-28 21:08:46 +08:00
parent 6532200897
commit ee7e54ccc3
3 changed files with 130 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
doc/docs/_sidebar.md
View File

@@ -1,22 +1,23 @@
* [首页](/?t=1555755370647)
* [首页](/?t=1556455222293)
* 开发文档
* [快速体验](files/10010_快速体验.md?t=1555755370648)
* [项目接入到SOP](files/10011_项目接入到SOP.md?t=1555755370667)
* [新增接口](files/10020_新增接口.md?t=1555755370667)
* [业务参数校验](files/10030_业务参数校验.md?t=1555755370667)
* [错误处理](files/10040_错误处理.md?t=1555755370667)
* [编写文档](files/10041_编写文档.md?t=1555755370667)
* [接口交互详解](files/10050_接口交互详解.md?t=1555755370667)
* [easyopen支持](files/10070_easyopen支持.md?t=1555755370667)
* [使用签名校验工具](files/10080_使用签名校验工具.md?t=1555755370667)
* [ISV管理](files/10085_ISV管理.md?t=1555755370667)
* [路由授权](files/10090_路由授权.md?t=1555755370668)
* [接口限流](files/10092_接口限流.md?t=1555755370668)
* [SDK开发](files/10095_SDK开发.md?t=1555755370668)
* [使用SpringCloudGateway](files/10096_使用SpringCloudGateway.md?t=1555755370668)
* [快速体验](files/10010_快速体验.md?t=1556455222295)
* [项目接入到SOP](files/10011_项目接入到SOP.md?t=1556455222316)
* [新增接口](files/10020_新增接口.md?t=1556455222316)
* [业务参数校验](files/10030_业务参数校验.md?t=1556455222316)
* [错误处理](files/10040_错误处理.md?t=1556455222317)
* [编写文档](files/10041_编写文档.md?t=1556455222317)
* [接口交互详解](files/10050_接口交互详解.md?t=1556455222317)
* [easyopen支持](files/10070_easyopen支持.md?t=1556455222317)
* [使用签名校验工具](files/10080_使用签名校验工具.md?t=1556455222317)
* [ISV管理](files/10085_ISV管理.md?t=1556455222317)
* [路由授权](files/10090_路由授权.md?t=1556455222317)
* [接口限流](files/10092_接口限流.md?t=1556455222317)
* [SDK开发](files/10095_SDK开发.md?t=1556455222317)
* [使用SpringCloudGateway](files/10096_使用SpringCloudGateway.md?t=1556455222318)
* [应用授权](files/10097_应用授权.md?t=1556455222318)
* 原理分析
* [原理分析之@ApiMapping](files/90010_原理分析之@ApiMapping.md?t=1555755370668)
* [原理分析之路由存储](files/90011_原理分析之路由存储.md?t=1555755370668)
* [原理分析之如何路由](files/90012_原理分析之如何路由.md?t=1555755370668)
* [原理分析之文档归纳](files/90013_原理分析之文档归纳.md?t=1555755370668)
* [常见问题](files/90100_常见问题.md?t=1555755370668)
* [原理分析之@ApiMapping](files/90010_原理分析之@ApiMapping.md?t=1556455222318)
* [原理分析之路由存储](files/90011_原理分析之路由存储.md?t=1556455222318)
* [原理分析之如何路由](files/90012_原理分析之如何路由.md?t=1556455222318)
* [原理分析之文档归纳](files/90013_原理分析之文档归纳.md?t=1556455222318)
* [常见问题](files/90100_常见问题.md?t=1556455222318)

109
doc/docs/files/10097_应用授权.md Normal file
View File

@@ -0,0 +1,109 @@
# 应用授权
## 概述
- 1、用户对开发者进行应用授权后，开发者可以帮助用户完成相应的业务逻辑。
- 2、授权采用标准的OAuth 2.0流程。
## 授权流程
![授权流程](images/10097_1.png "10097_1.png")
## 快速接入
- 第一步：应用授权URL拼装
拼接规则:
http://openauth.yourdomain.com/oauth2/appToAppAuth?app_id=2019032617262200001&redirect_uri=http%3a%2f%2flocalhost%3a8087%2foauth2callback
参数说明：
| 参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
|--------------|-------------|--------|----|---------------|--------------------------|
| app_id | 开发者应用的AppId | String | 是 | 开发者应用的AppId | 2015101400446982 |
| redirect_uri | 回调页面 | String | 是 | 参数需要UrlEncode | http%3A%2F%2Fexample.com |
- 第二步：获取code
接口名称：open.auth.token.app
开发者通过code可以换取app_auth_token、授权用户的userId。
**注意**：应用授权的code唯一，code使用一次后失效，有效期24小时； app_auth_token永久有效。
**请求参数说明**
| 参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
|---------------|------|--------|----|---------------------------------------------------------------------------------|------------------------------------------|
| grant_type | 授权类型 | String | 是 | 如果使用code换取token，则为authorization_code，如果使用refresh_token换取新的token，则为refresh_token | authorization_code |
| code | 授权码 | String | 否 | 与refresh_token二选一，用户对应用授权后得到，即第一步中开发者获取到的code值 | bf67d8d5ed754af297f72cc482287X62 |
| refresh_token | 刷新令牌 | String | 否 | 与code二选一，可为空，刷新令牌时使用 | 201510BB0c409dd5758b4d939d4008a525463X62 |
**接口请求SDK示例**
```java
@GetMapping("oauth2callback")
@ResponseBody
public String callback(HttpServletRequest servletRequest, HttpServletResponse servletResponse) {
String app_id = servletRequest.getParameter("app_id");
String code = servletRequest.getParameter("code");
OpenAuthTokenAppRequest request = new OpenAuthTokenAppRequest();
OpenAuthTokenAppModel model = new OpenAuthTokenAppModel();
model.setCode(code);
model.setGrant_type("authorization_code");
request.setBizModel(model);
// 根据code获取token
OpenAuthTokenAppResponse response = openClient.execute(request);
if (response.isSuccess()) {
// 成功拿到token，开发者在这里保存token信息
// 后续使用token进行接口访问
log.info("授权成功，body:{}", response.getBody());
}
return response.getBody();
}
```
**同步响应参数说明**
| 参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
|-------------------|---------|--------|----|----------------------------------------------------------|----------------------------------|
| app_auth_token | 用户授权令牌 | String | 是 | 通过该令牌来帮助用户发起请求，完成业务 | 856faf8d77d3b985c1073557ce6ea724 |
| user_id | 授权用户的ID | String | 是 | 授权者id | 1 |
| expires_in | 令牌有效期 | Long | 是 | 负值表示永久有效 | -1 |
| re_expires_in | 刷新令牌有效期 | Long | 是 | 负值表示永久有效 | -3 |
| app_refresh_token | 刷新令牌时使用 | String | 是 | 刷新令牌后，我们会保证老的app_auth_token从刷新开始10分钟内可继续使用，请及时替换为最新token | 88e68196d2359667f0dc8136e6c86803 |
**同步响应结果示例**
```json
{
"open_auth_token_app_response": {
"code": "10000",
"msg": "Success",
"app_auth_token": "88e68196d2359667f0dc8136e6c86803",
"app_refresh_token": "856faf8d77d3b985c1073557ce6ea724",
"expires_in": -1,
"re_expires_in": -3,
"user_id": "1"
},
"sign": "xxx"
}
```
**刷新token**
```java
OpenAuthTokenAppRequest request = new OpenAuthTokenAppRequest();
OpenAuthTokenAppModel model = new OpenAuthTokenAppModel();
model.setGrant_type("refresh_token");
model.setRefresh_token("856faf8d77d3b985c1073557ce6ea724");
request.setBizModel(model);
OpenAuthTokenAppResponse response = openClient.execute(request);
if (response.isSuccess()) {
// 成功拿到token，开发者在这里保存token信息
// 后续使用token进行接口访问
log.info("换取token成功，body:{}", response.getBody());
}
```

BIN
doc/docs/files/images/10097_1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 78 KiB