XuqmGroup 9c1dc4fbd7 docs(server): 添加服务器信息记录和联调接口文档

- 创建信息记录文档，包含项目管理要求、产物范围、Git仓库、制品仓库信息
- 添加服务器部署信息，包括应用服务器、MySQL/Redis服务器、Jenkins服务配置
- 记录邮件服务、DNS/HTTPS证书配置及安全备注
- 创建API联调文档，包含线上入口、ID约定、初始化管理员账号信息
- 添加统一响应格式、常见错误码、鉴权规则说明
- 提供核心接口清单，涵盖tenant-service、im-service、push-service等服务
- 补充curl示例，包含运营平台登录、IM登录、会话管理等操作示例
- 实现会话控制器，支持置顶、免打扰、标记已读、草稿等功能
- 添加全局异常处理器，统一处理业务异常和参数校验错误
- 创建IM管理控制器，提供用户管理、好友请求、黑名单等管理功能

2026-04-29 12:33:26 +08:00

1.3 KiB

原始文件 Blame 文件历史

快速开始

5 分钟接入 XuqmGroup IM，实现消息收发。

1. 注册账号与创建应用

访问 XuqmGroup 控制台
注册租户账号，创建应用
记录 appId（即 appKey）

2. 选择你的平台

平台	推荐接入方式
Android	Android SDK →
iOS	iOS SDK →
React Native	RN SDK →
Vue3 / Web	Vue3 SDK →
HarmonyOS	HarmonyOS SDK →

3. 演示环境

所有 SDK 均可直接连接演示环境验证功能：

API 地址：https://dev.xuqinmin.com
WS 地址：wss://dev.xuqinmin.com/ws/im
演示 AppId：ak_demo_chat
演示用户：demo_alice / demo_bob

4. 演示项目

手机端演示包和 Web 演示入口单独放在演示项目页面，便于直接扫码或跳转验证。

5. 接入流程

你的业务服务端
  → 持有 appId/appSecret
  → 调用 POST /api/im/auth/login?appId=&userId=&nickname= 换取 IM Token
  → 返回 Token 给客户端

客户端 SDK
  → 使用 Token 初始化 IM 连接
  → 建立 WebSocket 长连接
  → 开始收发消息

安全提示：appSecret 应仅在你的服务端持有，不应下发给客户端。

1.3 KiB 原始文件 Blame 文件历史 Unescape Escape

快速开始

1. 注册账号与创建应用

2. 选择你的平台

3. 演示环境

4. 演示项目

5. 接入流程

1.3 KiB

原始文件 Blame 文件历史