认证方式¶
UPath AI 导师平台提供两种认证方式,适用于不同的接口类型。
认证方式概览¶
| 认证方式 | 适用接口 | 说明 |
|---|---|---|
| JWT Token | 控制台接口 | 登录后获取,24 小时有效 |
| API Key | AIGC 接口 | 在官网控制台创建,长期有效 |
JWT Token 认证¶
JWT Token 认证用于控制台相关接口(如账户流水、调用日志、数据统计等)。
获取方式¶
- 访问 UPath 官网 登录您的账号
- 登录成功后系统会返回 Token
响应字段:
| 字段 | 说明 |
|---|---|
| access | Access Token,用于接口认证 |
| refresh | Refresh Token,用于刷新 Access Token |
使用方式¶
在请求头中携带 Token:
| 请求头 | 值 |
|---|---|
| Authorization | Bearer |
有效期¶
| Token 类型 | 有效期 |
|---|---|
| Access Token | 24 小时 |
| Refresh Token | 7 天 |
Token 刷新
Access Token 过期后,可使用 Refresh Token 获取新的 Access Token,无需重新登录。
API Key 认证¶
API Key 认证用于 AIGC 接口(getScenes、StartVoiceChat、StopVoiceChat)。
获取方式¶
- 登录 UPath 官网控制台
- 进入「API 密钥」菜单
- 点击「创建密钥」
- 保存生成的 API Key
妥善保管
API Key 创建后请妥善保管,密钥仅在创建时显示一次。
使用方式¶
支持两种方式传递 API Key:
方式一:请求头(推荐)
| 请求头 | 值 |
|---|---|
| X-API-Key | 你的 API Key |
方式二:查询参数
在 URL 中添加 api_key 参数:
https://api.upath.cn/api/aigc/getScenes?api_key={your_api_key}
安全建议
推荐使用请求头方式,避免 API Key 出现在 URL 中被日志记录。
密钥管理¶
所有密钥管理操作请在 官网控制台 进行:
| 操作 | 说明 |
|---|---|
| 创建密钥 | 每个账号可创建多个密钥 |
| 查看密钥 | 只能查看自己的密钥 |
| 删除密钥 | 删除后立即失效 |
| 设置过期时间 | 可选,不设置则永不过期 |
认证错误¶
JWT Token 错误¶
| HTTP 状态码 | 说明 |
|---|---|
| 401 | Token 无效或已过期 |
| 403 | 无权限访问该资源 |
API Key 错误¶
| HTTP 状态码 | 说明 |
|---|---|
| 401 | API Key 无效或已过期 |
| 403 | 账户余额不足或已禁用 |