016ad3cea1
- 新增多语言国际化文案支持笔记仓库模块 - 配置Universal Links与App Links支持ctc.s2ss.com域名跳转 - 实现CTS会话入口与会话时间更新逻辑 - 新增CTC笔记完整服务栈：API客户端、本地存储、同步服务 - 新增笔记编辑、预览、冲突解决、版本对比组件 - 新增二维码扫码/分享功能与路由配置 - 修复UrlAnalyzerService调用参数冗余问题 - 修复ProfileHeader组件样式问题 - 统一macOS部署目标版本为13.0 - 抑制liquid_glass_widgets高频调试日志
115 lines
2.4 KiB
Markdown
115 lines
2.4 KiB
Markdown
# 笔记仓库 (CTC) API 文档
|
||
|
||
## 基础信息
|
||
- 基础URL: `https://ctc.s2ss.com`
|
||
- 钥匙规则: 仅数字和字母，2-64位
|
||
- 内容限制: 单条笔记最大1MB
|
||
- 速率限制: 每IP每分钟60次请求
|
||
- CORS: 已开启
|
||
|
||
---
|
||
|
||
## 1. 读取笔记内容
|
||
|
||
| 项目 | 值 |
|
||
|---|---|
|
||
| URL | `/{key}?raw` |
|
||
| 方法 | GET |
|
||
| 参数 | `raw` (无值) |
|
||
| 成功 | 200 + 笔记内容 (text/plain) |
|
||
| 不存在 | 404 |
|
||
|
||
**示例**:
|
||
```
|
||
GET https://ctc.s2ss.com/my-diary?raw
|
||
→ 200 今天天气很好...
|
||
```
|
||
|
||
---
|
||
|
||
## 2. 写入/创建笔记
|
||
|
||
| 项目 | 值 |
|
||
|---|---|
|
||
| URL | `/{key}` |
|
||
| 方法 | GET / POST |
|
||
| 参数 | `text` (笔记内容) |
|
||
| 成功 | 200 + `saved` |
|
||
| JSON模式 | 加 `&json` 参数 |
|
||
| 超限 | 400 `{"code":0,"msg":"内容超过1MB限制"}` |
|
||
|
||
**示例**:
|
||
```
|
||
POST https://ctc.s2ss.com/my-diary?json
|
||
Body: text=Hello World
|
||
→ {"code":1,"msg":"saved","data":{"key":"my-diary","size":11,"mtime":1718000000,"exists":true}}
|
||
```
|
||
|
||
---
|
||
|
||
## 3. 创建随机笔记
|
||
|
||
| 项目 | 值 |
|
||
|---|---|
|
||
| URL | `/?new` |
|
||
| 方法 | GET / POST |
|
||
| 参数 | `text` (可选) |
|
||
| 成功 | 200 + 新笔记URL (string) |
|
||
| JSON模式 | 加 `&json` 参数 |
|
||
|
||
**示例**:
|
||
```
|
||
GET https://ctc.s2ss.com/?new&text=test&json
|
||
→ {"code":1,"msg":"created","data":{"key":"a3x7k","url":"https://ctc.s2ss.com/a3x7k","size":4}}
|
||
```
|
||
|
||
---
|
||
|
||
## 4. 获取笔记信息
|
||
|
||
| 项目 | 值 |
|
||
|---|---|
|
||
| URL | `/?info¬e={key}` |
|
||
| 方法 | GET |
|
||
| 成功 | `{"code":1,"data":{"key":"...","size":128,"mtime":1718000000,"exists":true}}` |
|
||
| 不存在 | 404 `{"code":0,"msg":"笔记不存在"}` |
|
||
|
||
---
|
||
|
||
## 5. 批量检查变更
|
||
|
||
| 项目 | 值 |
|
||
|---|---|
|
||
| URL | `/?check&keys=key1,key2,key3` |
|
||
| 方法 | GET |
|
||
| 成功 | `{"code":1,"data":{"key1":{"key":"key1","size":128,"mtime":...,"exists":true},"key2":null}}` |
|
||
|
||
**用途**: 客户端对比本地mtime与服务端mtime，判断笔记是否有变更（红点提示）
|
||
|
||
---
|
||
|
||
## 6. 删除笔记
|
||
|
||
| 项目 | 值 |
|
||
|---|---|
|
||
| URL | `/?delete¬e={key}` |
|
||
| 方法 | GET |
|
||
| 成功 | `{"code":1,"msg":"deleted"}` |
|
||
| 不存在 | 404 `{"code":0,"msg":"笔记不存在"}` |
|
||
|
||
---
|
||
|
||
## 错误码
|
||
|
||
| HTTP状态码 | code | msg | 说明 |
|
||
|---|---|---|---|
|
||
| 200 | 1 | - | 成功 |
|
||
| 400 | 0 | 无效的钥匙格式 | 钥匙不符合规则 |
|
||
| 400 | 0 | 内容超过1MB限制 | 内容超限 |
|
||
| 404 | 0 | 笔记不存在 | 笔记未找到 |
|
||
| 429 | 0 | 请求过于频繁 | 触发速率限制 |
|
||
|
||
---
|
||
|
||
*更新时间: 2026-06-11*
|