Browse Source

Token使用文档

pull/1/head
周雪成 3 years ago
parent
commit
eead194c61
2 changed files with 95 additions and 9 deletions
  1. 81
    5
      core/Token使用文档.md
  2. 14
    4
      file/文件服务器接口.md

+ 81
- 5
core/Token使用文档.md View File

1
 ### Token使用流程概述
1
 ### Token使用流程概述
2
-1.	向生态系统申请配置信息
3
-2.	使用系统名、用户名、密码请求Token 
4
-3.	将请求到的Token做为请求头Authorization的value,去请求内管的其他接口
5
-4.	每隔十分钟刷新token,每隔一小时重新获取token
6
-![Token](./image/token.jpg)
2
+1. 向生态系统申请系统名、用户名、密钥
3
+2. 使用 `getVirtualToken` 接口请求 token 
4
+3. 将 `token` 作为请求头 `Authorization` 的值,即可正常调用其他接口
5
+4. 每隔十分钟使用 `refreshToken` 接口刷新token,每隔一小时重新获取token
6
+![Token](./image/token.png)
7
+
8
+### getVirtualToken 获取token
9
+> 请求方式  ` POST http://172.20.109.105:7007/core/auth/getVirtualToken`
10
+> 数据格式 `Json`
11
+
12
+| 请求参数  | 类型 | 是否必填 | 说明 |
13
+| --- | --- | --- | --- | --- |
14
+| sysName | String| 是 | 系统名称 |
15
+| userCode | String | 是 | 用户名 |
16
+| password | String | 是 | 密钥 |
17
+
18
+| 返回参数  | 类型 | 是否比返 | 说明 |
19
+| --- | --- | --- | --- | --- |
20
+| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
21
+| errmsg | String | 否 | errcode不为0时有值 |
22
+| data | - | - | 包含数据见下 |
23
+| accessToken | String | 是 | 获取到的Token |
24
+| refreshToken | String | 是 | 用于刷新Token的 |
25
+
26
+请求示例
27
+
28
+```
29
+{
30
+    "sysName":"",
31
+    "userCode":"",
32
+    "password":""
33
+}
34
+```
35
+
36
+返回示例
37
+
38
+```
39
+{
40
+    "errcode":0,
41
+    "data":{
42
+        "accessToken":"",
43
+        "refreshToken:""
44
+    },
45
+    "errmsg":"SUCCESS"
46
+}
47
+```
48
+
49
+### refreshToken 获取token
50
+> 请求方式  ` POST http://172.20.109.105:7007/core/auth/refreshToken`
51
+> 数据格式 `Json`
52
+
53
+| 请求参数  | 类型 | 是否必填 | 说明 |
54
+| --- | --- | --- | --- | --- |
55
+| refreshToken | String| 是 | 获取Token时获取的refreshToken |
56
+
57
+| 返回参数  | 类型 | 是否比返 | 说明 |
58
+| --- | --- | --- | --- | --- |
59
+| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
60
+| errmsg | String | 否 | errcode不为0时有值 |
61
+| data | - | - | 包含数据见下 |
62
+| accessToken | String | 是 | 获取到的Token |
63
+
64
+请求示例
65
+
66
+```
67
+{
68
+    "refreshToken":""
69
+}
70
+```
71
+
72
+返回示例
73
+
74
+```
75
+{
76
+    "errcode":0,
77
+    "data":{
78
+        "accessToken":""
79
+    },
80
+    "errmsg":"SUCCESS"
81
+}
82
+```

+ 14
- 4
file/文件服务器接口.md View File

5
 - 请求大小不能大于20M
5
 - 请求大小不能大于20M
6
 - 包含Upload2Cmp和Upload两个接口,Upload2Cmp 上传视频,图片文件时会压缩文件大小
6
 - 包含Upload2Cmp和Upload两个接口,Upload2Cmp 上传视频,图片文件时会压缩文件大小
7
 - 为不影响压缩效果,视频、图片的文件名请以正确的扩展名结尾
7
 - 为不影响压缩效果,视频、图片的文件名请以正确的扩展名结尾
8
+- 服务器文件每日自动清理
8
 
9
 
9
-# 输入参数
10
-| 参数 | 说明 | 类型 | 长度(字节) | 是否必填 |
10
+# 
11
+> 请求方式  ` POST https://cepmtest.dhcccloud.com.cn/upload2cmp/`
12
+> 添加请求头 `Content-Type:multipart/form-data;`
13
+
14
+
15
+| 请求参数  | 类型 | 是否必填 | 说明 |
11
 | --- | --- | --- | --- | --- |
16
 | --- | --- | --- | --- | --- |
12
-| - | -| - | - | - | 
13
-# 调用示例
17
+| 无 | -| - | - |
14
 
18
 
19
+| 返回参数  | 类型 | 是否比返 | 说明 |
20
+| --- | --- | --- | --- | --- |
21
+| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
22
+| errmsg | String | 否 | errcode不为0时有值 |
23
+| data | String | 否 | 成功时返回文件存储路径,供其它接口使用 |
24
+# 调用示例
15
 #### java:
25
 #### java:
16
 ``` java
26
 ``` java
17
  
27
  

Loading…
Cancel
Save