API Overview

API 概览

Wiki 只提供导航。接口方法、参数、响应、错误码和 feature flag 以主仓库的机器可读契约和 API 参考为准。

官方参考

• REST API v1 目录
• API 格式规范
• 错误码
• WebSocket 协议
• OpenAPI 真源
• AsyncAPI 真源

连接原则

• REST 请求使用 HTTPS；WebSocket 使用 WSS。
• 需要认证的接口必须携带有效 JWT；公开接口以 API 契约标记为准。
• 64-bit ID 按项目约定处理，不要在 JavaScript 中直接当作安全整数。
• 附件 URL 必须经过服务端授权，不要直接暴露原始对象存储地址。
• E2EE 消息的 payload 是密文，客户端负责加解密，服务端只做路由和持久化。

本地调试

优先使用仓库内 API sandbox、OpenAPI 文件和测试用例；不要把真实 token、Cookie、手机号或生产域名粘贴到公共调试工具。