84 lines
2.2 KiB
Markdown
84 lines
2.2 KiB
Markdown
|
# API 文档 - 获取会话信息
|
|||
|
|
|
|||
|
|
## 元数据
|
|||
|
|
- 需求编号：001
|
|||
|
|
- 子需求编号：001-01
|
|||
|
|
- 接口编号：001
|
|||
|
|
- 创建时间：2026-02-02
|
|||
|
|
- 创建人：AI Assistant
|
|||
|
|
- 状态：已完成
|
|||
|
|
|
|||
|
|
## 接口概述
|
|||
|
|
获取当前用户的 Session ID 和实例 URL，用于后续的 Salesforce API 调用。
|
|||
|
|
|
|||
|
|
## 基本信息
|
|||
|
|
|
|||
|
|
- **功能描述**：获取当前用户的 Session ID 和实例 URL
|
|||
|
|
- **请求方式**：GET
|
|||
|
|
- **请求路径**：`/partner/connection/session`
|
|||
|
|
- **权限要求**：`@PreAuthorize("@ss.hasLogin()")`
|
|||
|
|
|
|||
|
|
## 请求参数
|
|||
|
|
|
|||
|
|
无
|
|||
|
|
|
|||
|
|
## 响应参数
|
|||
|
|
|
|||
|
|
| 参数名 | 类型 | 说明 |
|
|||
|
|
|--------|------|------|
|
|||
|
|
| code | Integer | 状态码（200 成功，其他失败） |
|
|||
|
|
| msg | String | 提示信息 |
|
|||
|
|
| data | Object | 响应数据 |
|
|||
|
|
| data.sessionId | String | Session ID，用于后续的 Salesforce API 调用 |
|
|||
|
|
| data.instanceUrl | String | 实例 URL，用于后续的 Salesforce API 调用 |
|
|||
|
|
|
|||
|
|
### 成功响应示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 200,
|
|||
|
|
"msg": "操作成功",
|
|||
|
|
"data": {
|
|||
|
|
"sessionId": "00D5w00000AaBC!AQEAQKx...",
|
|||
|
|
"instanceUrl": "https://yourinstance.my.salesforce.com"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 失败响应示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 500,
|
|||
|
|
"msg": "获取会话信息失败: 未找到有效的会话",
|
|||
|
|
"data": null
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 错误码
|
|||
|
|
|
|||
|
|
| 错误码 | 说明 | 处理建议 |
|
|||
|
|
|--------|------|----------|
|
|||
|
|
| 200 | 操作成功 | - |
|
|||
|
|
| 401 | 未登录或登录已过期 | 请重新登录 |
|
|||
|
|
| 500 | 服务器内部错误 | 请联系管理员或稍后重试 |
|
|||
|
|
|
|||
|
|
## 注意事项
|
|||
|
|
|
|||
|
|
1. Session ID 是访问 Salesforce API 的关键凭证，请妥善保管
|
|||
|
|
2. Session ID 有有效期限制，过期后需要重新获取
|
|||
|
|
3. instanceUrl 用于构建完整的 API 请求 URL
|
|||
|
|
4. 此接口需要用户已登录到系统
|
|||
|
|
5. Session ID 可以用于直接调用 Salesforce API，无需再次认证
|
|||
|
|
|
|||
|
|
## 使用场景
|
|||
|
|
|
|||
|
|
- 在需要直接调用 Salesforce API 时获取认证信息
|
|||
|
|
- 验证当前会话是否有效
|
|||
|
|
- 获取 Salesforce 实例 URL 用于 API 调用
|
|||
|
|
|
|||
|
|
## 相关文档
|
|||
|
|
- [需求文档](../../requirements/2026-01-28-001-PartnerAPI源org实现.md)
|
|||
|
|
- [设计文档](../../design/2026-01-29-001-01-认证和会话管理-设计.md)
|
|||
|
|
- [决策记录](../../decisions/2026-01-29-001-01-ADR-认证和会话管理技术选型.md)
|