92 lines
2.2 KiB
Markdown
92 lines
2.2 KiB
Markdown
|
# API 文档 - 获取服务器时间戳
|
|||
|
|
|
|||
|
|
## 元数据
|
|||
|
|
- 需求编号：001
|
|||
|
|
- 子需求编号：001-01
|
|||
|
|
- 接口编号：005
|
|||
|
|
- 创建时间：2026-02-02
|
|||
|
|
- 创建人：AI Assistant
|
|||
|
|
- 状态：已完成
|
|||
|
|
|
|||
|
|
## 接口概述
|
|||
|
|
获取 Salesforce 服务器的当前时间戳和时区信息。
|
|||
|
|
|
|||
|
|
## 基本信息
|
|||
|
|
|
|||
|
|
- **功能描述**：获取 Salesforce 服务器当前时间戳
|
|||
|
|
- **请求方式**：GET
|
|||
|
|
- **请求路径**：`/partner/advanced/server-timestamp`
|
|||
|
|
- **权限要求**：`@PreAuthorize("@ss.hasPermi('partner:advanced:serverTimestamp')")`
|
|||
|
|
|
|||
|
|
## 请求参数
|
|||
|
|
|
|||
|
|
无
|
|||
|
|
|
|||
|
|
## 响应参数
|
|||
|
|
|
|||
|
|
| 参数名 | 类型 | 说明 |
|
|||
|
|
|--------|------|------|
|
|||
|
|
| code | Integer | 状态码（200 成功，其他失败） |
|
|||
|
|
| msg | String | 提示信息 |
|
|||
|
|
| data | Object | 响应数据 |
|
|||
|
|
| data.timestamp | String | 服务器时间戳（ISO 8601 格式） |
|
|||
|
|
| data.timeZone | String | 时区 |
|
|||
|
|
| data.success | Boolean | 是否成功 |
|
|||
|
|
| data.errors | Array | 错误信息列表 |
|
|||
|
|
|
|||
|
|
### 成功响应示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 200,
|
|||
|
|
"msg": "操作成功",
|
|||
|
|
"data": {
|
|||
|
|
"timestamp": "2026-02-02T10:30:00.000Z",
|
|||
|
|
"timeZone": "Asia/Shanghai",
|
|||
|
|
"success": true,
|
|||
|
|
"errors": null
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 失败响应示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 500,
|
|||
|
|
"msg": "获取服务器时间戳失败",
|
|||
|
|
"data": {
|
|||
|
|
"timestamp": null,
|
|||
|
|
"timeZone": null,
|
|||
|
|
"success": false,
|
|||
|
|
"errors": [
|
|||
|
|
{
|
|||
|
|
"statusCode": "UNKNOWN_EXCEPTION",
|
|||
|
|
"message": "Failed to retrieve server timestamp"
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 错误码
|
|||
|
|
|
|||
|
|
| 错误码 | 说明 | 处理建议 |
|
|||
|
|
|--------|------|----------|
|
|||
|
|
| 200 | 操作成功 | - |
|
|||
|
|
| 401 | 未登录或登录已过期 | 请重新登录 |
|
|||
|
|
| 403 | 无权限访问 | 请检查用户权限 |
|
|||
|
|
| 500 | 服务器内部错误 | 请联系管理员或稍后重试 |
|
|||
|
|
|
|||
|
|
## 注意事项
|
|||
|
|
|
|||
|
|
1. 时间戳格式为 ISO 8601 标准（YYYY-MM-DDTHH:mm:ss.sssZ）
|
|||
|
|
2. 时区信息可用于时间转换和显示
|
|||
|
|
3. 此接口可用于同步本地时间与服务器时间
|
|||
|
|
4. 建议在需要精确时间操作时调用此接口
|
|||
|
|
|
|||
|
|
## 相关文档
|
|||
|
|
- [需求文档](../../requirements/2026-01-28-001-PartnerAPI源org实现.md)
|
|||
|
|
- [设计文档](../../design/2026-01-29-001-01-认证和会话管理-设计.md)
|
|||
|
|
- [决策记录](../../decisions/2026-01-29-001-01-ADR-认证和会话管理技术选型.md)
|