pangu-user-platform/docs/应用管理使用说明.md

119 lines
3.4 KiB
Markdown
Raw Normal View History

# 应用管理使用说明
## 功能概述
应用管理用于管理接入盘古用户认证中心的第三方应用系统。通过该功能可以为外部系统分配唯一的应用编码AppCode和密钥AppSecret并控制其可调用的开放接口权限。
## 访问路径
管理后台地址:`http://localhost/application`
## 功能说明
### 1. 应用列表
列表展示所有已接入的第三方应用,包含以下信息:
| 字段 | 说明 |
|------|------|
| 应用名称 | 第三方应用的名称 |
| 应用编码 | 系统自动生成的唯一标识AppCode |
| 授权接口 | 该应用被授权可调用的 API 接口 |
| 状态 | 正常/停用 |
| 创建时间 | 应用创建时间 |
| 创建人 | 创建该应用的管理员 |
**搜索功能**:支持按应用名称、应用编码、状态进行筛选查询。
### 2. 新增应用
点击【新增】按钮,填写以下信息:
| 字段 | 必填 | 说明 |
|------|------|------|
| 应用名称 | 是 | 第三方应用的名称最多50字符 |
| 应用编码 | - | 保存后系统自动生成,无需填写 |
| 应用描述 | 否 | 应用的用途说明最多200字符 |
| 联系人 | 否 | 第三方应用对接负责人 |
| 联系电话 | 否 | 联系人手机号 |
| 状态 | 是 | 默认为"正常",停用后该应用无法调用接口 |
| 接口授权 | 否 | 勾选该应用可调用的开放接口 |
保存成功后,系统会自动生成:
- **AppCode**:应用唯一编码
- **AppSecret**32位应用密钥
### 3. 编辑应用
点击操作列的【编辑】按钮,可修改应用信息和接口授权。
> 注意应用编码AppCode创建后不可修改。
### 4. 重置密钥
点击【重置密钥】按钮系统会重新生成一个32位的新密钥。
⚠️ **重要提醒**
- 重置后原密钥立即失效
- 新密钥只显示一次,请务必复制保存
- 第三方应用需要同步更新密钥配置
### 5. 删除应用
点击【删除】按钮,删除该应用。
⚠️ **注意**:删除后该应用的 AppCode 和 AppSecret 将永久失效,第三方系统将无法继续调用接口。
## 第三方应用接入指南
### 接入流程
1. 在应用管理中创建新应用
2. 获取 AppCode 和 AppSecret
3. 在第三方系统中配置凭证
4. 按照接口规范调用开放接口
### 接口调用认证
第三方应用调用开放接口时,需要在请求头中携带认证信息:
```http
GET /open/api/student/list HTTP/1.1
Host: your-domain.com
X-App-Code: {应用编码}
X-App-Secret: {应用密钥}
X-Timestamp: {时间戳}
X-Sign: {签名}
```
### 签名规则
```
sign = MD5(appCode + appSecret + timestamp)
```
### 可用的开放接口
| 接口编码 | 接口名称 | 请求方式 | 路径 |
|---------|---------|---------|------|
| OPEN_STUDENT_LIST | 学生列表 | GET | /open/api/student/list |
> 更多接口请联系管理员开放授权。
## 常见问题
**Q: 忘记了应用密钥怎么办?**
A: 密钥无法找回,请使用【重置密钥】功能生成新密钥。
**Q: 应用被停用后还能调用接口吗?**
A: 不能,停用状态的应用所有接口调用都会返回"应用已停用"错误。
**Q: 如何新增开放接口?**
A: 需要联系系统管理员在 API 字典表中添加新接口,并在应用管理中授权。
---
*文档版本v1.0*
*更新日期2026-02-04*
*维护团队:盘古研发团队*