DEVELOPER DOCUMENTATION / V1
账号与功能接口文档
供 ctrlC 客户端与后续功能服务对接。基础剪贴板继续在本地免费运行。
接入顺序
- 注册或登录;将 Bearer Token 存入系统安全存储。
- 获取 /me 和 /features,分别显示会员、额度、功能权限与安装状态。
- 平台翻译调用 /translate,自带密钥翻译由客户端直连。
- 插件安装前校验 HTTPS 下载地址和 SHA-256,按设备上报安装/启用状态。
- 收费资源操作必须在真正的后端操作接口内重新鉴权,不能仅信任客户端界面或授权响应。
当前只提供云存储权限位与插件注册机制,未提供云文件上传/同步、截图插件本体、支付收款、邮件验证与邮件找回。用户密钥不得提交到平台翻译接口。
鉴权与错误
Authorization: Bearer <access_token>
Content-Type: application/json
Idempotency-Key: <每个翻译任务唯一且稳定的 UUID>
成功:{"data": {...}}
错误:{"error": {"code": "QUOTA_EXHAUSTED", "message": "额度不足"}}
Token 有效期七天;退出注销当前会话,修改密码或停用账号注销全部会话。浏览器后台使用 HttpOnly Cookie,并校验写操作 Origin。
双额度与重试
Token 上限与调用次数上限同时生效,任一额度不足均拒绝请求。预留值包含输入估算、最大输出和图片预算;余额需要覆盖预留,成功后释放预留并计入实际回执。模型缺失 usage 时按预留量估算结算并标记 estimated。失败退回用户预留;平台仍可能承担上游失败的费用。
每个翻译任务固定一个 Idempotency-Key;重试复用相同键。相同键不同内容返回 409。成功译文加密缓存 24 小时用于幂等重试,过期不再返回译文;管理员只能查看计量元数据。进程中断产生的预留记录不会自动当作失败退款,超过五分钟后须核对上游账单。
平台翻译示例
POST /api/v1/translate
Authorization: Bearer ...
Idempotency-Key: 9f24a2ab-...(示意)
{
"text": "Good ideas are worth keeping.",
"source_language": "en",
"target_language": "zh"
}
语言代码:auto(只用于源语言)、zh、en、ja、ko、fr、de、es、ru、pt、it、ar。文字和图片可同时提供;图片使用 image.mime_type 与 image.data_base64。PNG/JPEG 原文件不超过 1 MB,模型需要支持图片输入。
完整接口清单
OpenAPI JSON ↗详细部署、MySQL 建表脚本与客户端示例见项目中的 docs/。公网文档地址在正式部署后确定。