XuqmGroup-Web/docs-site/docs/guide/quickstart.md
XuqmGroup fb82e4b8b6 docs(sdk): 添加 Android SDK 文档和 API 设计规范
- 新增 Android SDK 使用文档,包含模块结构、集成方式和快速开始指南
- 添加 SDK API 重设计规范,统一初始化和登录接口设计
- 补充安全设计规范,完善 UserSig 鉴权和敏感数据处理方案
- 创建平台 REST API 规范,定义服务端到服务端的调用接口
- 添加离线推送架构设计,集成各大厂商推送服务与 IM 联动方案
2026-04-29 15:46:40 +08:00

1.3 KiB

快速开始

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

1. 注册账号与创建应用

  1. 访问 XuqmGroup 控制台
  2. 注册租户账号,创建应用
  3. 记录 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
演示 AppKeyak_demo_chat
演示用户demo_alice / demo_bob

4. 演示项目

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

5. 接入流程

你的业务服务端
  → 持有 appKey/appSecret
  → 调用 IM 登录接口换取 IM Token
  → 平台内部协议字段由 SDK 和后端自动处理,业务方无需感知
  → 返回 Token 给客户端

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

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