Token使用文档

core/Token使用文档.md

@@ -1,6 +1,82 @@
 ### Token使用流程概述
-1.	向生态系统申请配置信息
-2.	使用系统名、用户名、密码请求Token 
-3.	将请求到的Token做为请求头Authorization的value，去请求内管的其他接口
-4.	每隔十分钟刷新token，每隔一小时重新获取token
-![Token](./image/token.jpg)
+1. 向生态系统申请系统名、用户名、密钥
+2. 使用 `getVirtualToken` 接口请求 token 
+3. 将 `token` 作为请求头 `Authorization` 的值，即可正常调用其他接口
+4. 每隔十分钟使用 `refreshToken` 接口刷新token，每隔一小时重新获取token
+![Token](./image/token.png)
+
+### getVirtualToken 获取token
+> 请求方式  ` POST http://172.20.109.105:7007/core/auth/getVirtualToken`
+> 数据格式 `Json`
+
+| 请求参数  | 类型 | 是否必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| sysName | String| 是 | 系统名称 |
+| userCode | String | 是 | 用户名 |
+| password | String | 是 | 密钥 |
+
+| 返回参数  | 类型 | 是否比返 | 说明 |
+| --- | --- | --- | --- | --- |
+| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
+| errmsg | String | 否 | errcode不为0时有值 |
+| data | - | - | 包含数据见下 |
+| accessToken | String | 是 | 获取到的Token |
+| refreshToken | String | 是 | 用于刷新Token的 |
+
+请求示例
+
+```
+{
+    "sysName":"",
+    "userCode":"",
+    "password":""
+}
+```
+
+返回示例
+
+```
+{
+    "errcode":0,
+    "data":{
+        "accessToken":"",
+        "refreshToken:""
+    },
+    "errmsg":"SUCCESS"
+}
+```
+
+### refreshToken 获取token
+> 请求方式  ` POST http://172.20.109.105:7007/core/auth/refreshToken`
+> 数据格式 `Json`
+
+| 请求参数  | 类型 | 是否必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| refreshToken | String| 是 | 获取Token时获取的refreshToken |
+
+| 返回参数  | 类型 | 是否比返 | 说明 |
+| --- | --- | --- | --- | --- |
+| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
+| errmsg | String | 否 | errcode不为0时有值 |
+| data | - | - | 包含数据见下 |
+| accessToken | String | 是 | 获取到的Token |
+
+请求示例
+
+```
+{
+    "refreshToken":""
+}
+```
+
+返回示例
+
+```
+{
+    "errcode":0,
+    "data":{
+        "accessToken":""
+    },
+    "errmsg":"SUCCESS"
+}
+```

file/文件服务器接口.md

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