Server API reference
服务端 API 概览
服务端 API 供可信后端管理应用用户、签发客户端 token、发送消息、管理群组、上传文件、触发推送并访问 AI 能力。
架构与入口
服务端 API 是按应用隔离的 HTTP JSON 接口，使用部署的 api_endpoint，并通过控制台提供的 app_id 与 access-token 请求头鉴权。
Reference 导航
根据当前任务选择最精确的参考页面。以下条目均链接到本站托管的自动生成 API 文档。
Users说明 Users 的完整 API、参数、返回值、错误与回调约定。Tokens说明 Tokens 的完整 API、参数、返回值、错误与回调约定。Rosters说明 Rosters 的完整 API、参数、返回值、错误与回调约定。Groups说明 Groups 的完整 API、参数、返回值、错误与回调约定。Messages说明 Messages 的完整 API、参数、返回值、错误与回调约定。Files说明 Files 的完整 API、参数、返回值、错误与回调约定。Push说明 Push 的完整 API、参数、返回值、错误与回调约定。AI说明 AI 的完整 API、参数、返回值、错误与回调约定。推荐集成流程
- 从控制台获取 api_endpoint、app_id 与 access-token，并只把 access-token 存储在后端密钥管理中。
- 创建或映射应用用户，再为相应客户端 SDK 签发用户 token。
- 由后端调用资源接口，配置超时、错误处理与必要的幂等策略。
- 仅执行已经由自身业务权限模型授权的消息与管理操作。
- 定期轮换密钥，并分离生产、测试、专属云与私有云端点配置。
使用时需要注意
- API 签名与标识符必须保持不变；AI 解释只补充集成语义。
- 先确认对象生命周期、线程与异步回调，再把结果同步到 UI。
- 如果 AI 解释与当前 SDK 签名冲突，应以签名和实际版本为准。
继续阅读
Server API
环境与鉴权
调用 API 前，从控制台获取 api_endpoint、app_id 和 access-token。请求 Header 携带 app_id 与 access-token；默认 Content-Type 为 application/json。
托管 API 地址
http://s-1-3-api.maximtop.cn
以应用实际返回的 api_endpoint 为准。专属云和私有部署使用各自的服务地址。
请求参数
| 字段 | 说明 |
|---|---|
api_endpoint | 应用部署对应的 Base URL。 |
app_id | 通过请求 Header 发送的应用标识。 |
access-token | 通过请求 Header 发送的服务端凭据，不得暴露给客户端。 |
Content-Type | 接口未特殊说明时使用 application/json。 |
文档版本：v1.0