dadedbc4df
- Add docs-site workspace (VitePress 1.5.0) with Android/iOS/RN/Vue3/HarmonyOS/Server docs - Update Dockerfile to build and serve docs under /docs/ - Add /docs/ location block to Nginx config - Add docs-site to yarn workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
47 行
1.1 KiB
Markdown
47 行
1.1 KiB
Markdown
# 快速开始
|
||
|
||
5 分钟接入 XuqmGroup IM，实现消息收发。
|
||
|
||
## 1. 注册账号与创建应用
|
||
|
||
1. 访问 [XuqmGroup 控制台](https://sentry.xuqinmin.com)
|
||
2. 注册租户账号，创建应用
|
||
3. 记录 `appId`（即 `appKey`）
|
||
|
||
## 2. 选择你的平台
|
||
|
||
| 平台 | 推荐接入方式 |
|
||
|------|------------|
|
||
| Android | [Android SDK →](/android/) |
|
||
| iOS | [iOS SDK →](/ios/) |
|
||
| React Native | [RN SDK →](/rn/) |
|
||
| Vue3 / Web | [Vue3 SDK →](/vue3/) |
|
||
| HarmonyOS | [HarmonyOS SDK →](/harmony/) |
|
||
|
||
## 3. 演示环境
|
||
|
||
所有 SDK 均可直接连接演示环境验证功能：
|
||
|
||
```
|
||
API 地址：https://sentry.xuqinmin.com
|
||
WS 地址：wss://sentry.xuqinmin.com/ws/im
|
||
演示 AppId：ak_demo_chat
|
||
演示用户：demo_alice / demo_bob
|
||
```
|
||
|
||
## 4. 接入流程
|
||
|
||
```
|
||
你的业务服务端
|
||
→ 持有 appId/appSecret
|
||
→ 调用 POST /api/im/auth/login?appId=&userId=&nickname= 换取 IM Token
|
||
→ 返回 Token 给客户端
|
||
|
||
客户端 SDK
|
||
→ 使用 Token 初始化 IM 连接
|
||
→ 建立 WebSocket 长连接
|
||
→ 开始收发消息
|
||
```
|
||
|
||
> **安全提示**：appSecret 应仅在你的服务端持有，不应下发给客户端。
|
