xuqmGroup/XuqmGroup-Web
0
0
派生 0
代码 工单 合并请求 版本发布 百科 动态
57f8b36fab
XuqmGroup-Web/docs-site/docs/guide/flow.md
XuqmGroup 57f8b36fab docs(deploy): 移除 Jenkins 配置和 Android Demo 计划文档 
- 删除 jenkins-setup.md 完整的 Jenkins 服务配置指南
- 更新 README.md 部署文档标题为公有化部署文档
- 添加私有化部署说明章节和相关设计文档链接
- 从 REST API 设计文档中移除 demo-service 相关描述
- 更新推送架构图中业务服务端描述为客户端服务器
- 删除 android-demo-plan.md Android Demo 开发计划文档
- 删除 multi-platform-im-roadmap.md 多平台 IM 路线图文档
- 删除 java-im-server-sdk-plan.md Java IM 服务端 SDK 计划文档
2026-05-18 17:57:05 +08:00

1.7 KiB
原始文件 Blame 文件历史

接入流程

本文说明公有化和私有化两种接入流程。

公有化流程

  1. 访问 https://dev.xuqinmin.com。
  2. 注册开发者账号。
  3. 创建应用并获取 appKey。
  4. 业务服务端保存 appSecret。
  5. 客户端使用公有化 SDK 初始化。
  6. 业务服务端签发 UserSig。
  7. 客户端登录 SDK 并开始收发消息。

私有化流程

  1. 运维在私有化部署仓库执行一键部署。
  2. 部署脚本使用用户提供的 MySQL、Redis、域名、证书、SMTP 和厂商凭证完成配置。
  3. 系统初始化内置主租户、运营管理员和默认应用。
  4. 文档站生成私有化 SDK 接入示例。
  5. 客户端集成私有化 SDK。
  6. 客户端使用 xuqm-private-sdk.json 初始化。
  7. 业务服务端签发 UserSig。
  8. 客户端登录 SDK 并使用 IM、Push、Update、File、License 能力。

服务端签发 UserSig

服务端可以通过服务端 SDK 本地生成 UserSig，也可以调用平台接口生成。appSecret 必须只保存在服务端。

业务服务端
  -> 持有 appKey / appSecret
  -> 根据业务用户 ID 签发 UserSig
  -> 返回给客户端

客户端登录

客户端
  -> 业务登录成功
  -> 获取 userSig
  -> XuqmSDK.login(userId, userSig)
  -> IM WebSocket 连接
  -> Push / Update / License 模块按需工作

私有化注意事项

  1. 私有化环境不开放主租户注册。
  2. 私有化 SDK 不使用 dev.xuqinmin.com 作为默认地址。
  3. 厂商推送和应用市场自动发布需要客户网络放通厂商公网 API。
  4. MySQL、Redis 由客户提供，部署脚本只做连接校验。

快速开始