Files
qipai/docs/api-changelog/2026-08-10-M08-D-admin-overview.md
T
2026-08-10 12:20:56 +08:00

50 lines
4.0 KiB
Markdown

# 2026-08-10 M08-D 后台运营总览 API
| 方法 | 路径 | 权限 | 结果 |
|---|---|---|---|
| GET | `/admin-api/statistics` | `store.operation.read` 且门店在授权范围,或租户/平台管理权限 | 与小程序管理端共享同一统计仓储,返回最长 93 天的订单、成功实收、会员、房态、支付渠道、每日收入和验券汇总。 |
| GET | `/admin-api/stores` | 既有门店读权限与数据范围 | 运营总览只展示当前账号有权查看的门店,用于统计门店选择。 |
后台 API 基地址仍固定为 `/admin-api`。新增别名不复制统计逻辑,不降低鉴权;实收只累计 `SUCCEEDED` 支付,房态为查询时快照,订单和验券按各自创建时间口径。
## 门店与房间管理增量
| 方法 | 路径 | 变更 |
|---|---|---|
| GET | `/admin-api/stores` | 增加 `businessHours``wifiConfigured`、经纬度、联系电话、Wi-Fi SSID、通知地址和排序;不返回 Wi-Fi 密码。 |
| POST/PUT | `/admin-api/stores[/:id]` | `wifiPassword` 改为可省略;创建时省略写入空值,更新时省略使用 `COALESCE` 保持原密码。 |
| GET/POST/PUT/PATCH/DELETE | `/admin-api/stores/:storeId/rooms``/admin-api/rooms/**` | Vue 后台接入既有房间列表、创建、编辑、状态、停用时段和归档接口,权限契约不变。 |
## 订单运营增量
| 方法 | 路径 | 变更 |
|---|---|---|
| GET | `/admin-api/orders` | 新增后台别名,支持 `page``pageSize``status``storeId`,复用订单仓储的租户和授权门店范围。 |
| GET | `/admin-api/orders/:orderId` | 新增后台详情别名,返回服务端金额、时段、门店/房间和最近支付摘要。 |
| GET | `/admin-api/orders/:orderId/history` | 新增后台状态流水别名,复用经理数据范围校验。 |
| POST | `/admin-api/orders/:orderId/actions|note|adjust-time|renew|change-room` | Vue 后台接入既有受控写接口;服务端继续校验状态机、金额、时段冲突、权限和幂等。 |
## 资金运营增量
- 无新后端路由;Vue 后台接入既有 `/admin-api/pay/refund``/pay/reconciliation``/pay/collection-account``/pay/profit-share-receiver``/pay/profit-share-policy``/pay/profit-shares`
- 收款账户与接收方凭据只提交环境引用;列表继续只返回商户号、脱敏标识和授权状态,不返回私钥或真实接收方账户。
- 客户端生成一次性幂等键,但退款金额、可退余额、分账比例、授权与生产 Mock 门禁继续完全由服务端判定。
## 团购与第三方平台运营增量
| 方法 | 路径 | 变更 |
|---|---|---|
| GET | `/admin-api/third-party/records` | Vue 后台接入既有直订与核销记录,支持平台、门店和状态过滤。 |
| GET | `/admin-api/third-party/setup` | 新增管理员安全读取接口,返回平台模式、环境凭据引用是否配置、过滤后的非敏感设置和资源映射;要求租户管理或平台管理员权限。 |
| PUT | `/admin-api/third-party/config``/admin-api/third-party/mappings` | Vue 后台接入既有配置与映射写接口,继续验证租户资源和环境凭据引用。 |
| POST | `/admin-api/group-vouchers/redeem``/admin-api/group-vouchers/redeem-manual` | 补齐管理员后台 API/人工验券入口,与小程序管理端共享金额、权限、幂等和券码脱敏逻辑。 |
## 会员与员工用户管理增量
| 方法 | 路径 | 变更 |
|---|---|---|
| GET | `/admin-api/members``/admin-api/members/:id` | Vue 后台接入既有会员聚合与详情接口,读取余额、权益、订单、充值和最近流水,权限范围不变。 |
| GET | `/admin-api/users?userType=STAFF` | 新增可选 STAFF-only 过滤参数;只接受固定枚举 `STAFF`,确保全部角色员工视图不混入顾客。 |
| POST/PATCH | `/admin-api/staff``/admin-api/users/:id` | Vue 后台接入既有员工创建、资料、角色、门店和状态写接口,继续撤销权限变化后的会话并写审计。 |
| POST | `/admin-api/users/:id/reset-sessions` | Vue 后台接入既有会话重置入口。 |