XuqmGroup-Web/docs-site/docs/guide/quickstart.md

51 行
1.3 KiB
Markdown

# 快速开始
5 分钟接入 XuqmGroup IM,实现消息收发。
## 1. 注册账号与创建应用
1. 访问 [XuqmGroup 控制台](https://dev.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://dev.xuqinmin.com
WS 地址wss://dev.xuqinmin.com/ws/im
演示 AppIdak_demo_chat
演示用户demo_alice / demo_bob
```
## 4. 演示项目
手机端演示包和 Web 演示入口单独放在 [演示项目](/demo/) 页面,便于直接扫码或跳转验证。
## 5. 接入流程
```
你的业务服务端
→ 持有 appId/appSecret
→ 调用 POST /api/im/auth/login?appId=&userId=&nickname= 换取 IM Token
→ 返回 Token 给客户端
客户端 SDK
→ 使用 Token 初始化 IM 连接
→ 建立 WebSocket 长连接
→ 开始收发消息
```
> **安全提示**appSecret 应仅在你的服务端持有,不应下发给客户端。