API 概览
本页从业务视角介绍 WPF 智慧 IoT 解决方案对外开放的能力范围,帮助你快速定位所需的接口模块。
一、能力范围
Section titled “一、能力范围”WPF 智慧 IoT 解决方案通过统一的 REST API 对外提供接入能力,覆盖账号认证、组织协作、IoT 设备管理、即时通讯与音视频通话等场景。所有接口共享一致的接入方式:
- 统一域名:
https://devapi.fengshengshou.com - 统一鉴权:Bearer Token(JWT),通过注册 / 登录获取,详见 快速开始。
- 统一响应:
{ code, message, data },code = 0表示成功。
二、功能模块
Section titled “二、功能模块”| 模块 | 能力简介 |
|---|---|
| 认证授权 | 账号注册、登录、Token 刷新、修改密码、查询当前登录用户信息 |
| 用户管理 | 个人资料查询与修改、头像上传、账号注销 |
| 组织架构 | 组织部门树、成员搜索、同事列表查询 |
| 设备管理 | 设备列表与详情、指令下发、实时遥测、实时连接、设备分组 |
| 好友管理 | 好友列表、用户搜索、好友申请与处理、备注管理 |
| 群组管理 | 群组列表、创建群组、成员管理、群组信息设置 |
| 即时通讯 | 会话列表、发送消息、消息记录、消息撤回 |
| 音视频通话 | 通话发起、接听 / 拒绝 / 挂断控制、通话状态查询、RTC 接入凭证 |
| GM 场景模块 | Unity VR 场景房间 Seed 创建、场景快照存取与还原 |
| 其他 | 文件 / 语音上传、通知中心 |
三、通用约定
Section titled “三、通用约定”- 请求路径:均以
/api/开头,例如https://devapi.fengshengshou.com/api/auth/login。 - 请求头:受保护接口需携带
Authorization: Bearer <access_token>,并建议携带Accept: application/json。 - 数据格式:请求与响应均为 JSON;文件上传类接口使用
multipart/form-data。 - 分页:列表类接口通常支持
page与per_page参数,并在响应中返回pagination分页信息。