Просмотр исходного кода

余额接入文档仅保留数据定义

doge 21 часов назад
Родитель
Сommit
3f440d7a38

+ 1 - 1
docs/前端交付/bot-28/后台/后台实时推送-前端接入.md

@@ -302,7 +302,7 @@ Echo 回调收到的对象:
 | `admin.stats.platform_count` | `total`、`apple`、`android`、`pc`、`mobile`、`wechat`、`unknown` |
 | `admin.stats.unprocessed` | `usdtRecharge`、`rgRecharge`、`rmbRecharge`、`usdtWithdraw`、`rgWithdraw`、`rmbWithdraw`、`agentRecharge`、`agentApplication`、`agentPlanApplication`、`shareClaim` |
 
-首页先用 `GET /admin/home/third-game-balance` 获取快照,再订阅 `admin.stats.third_game_balance` 的 `stats.updated`。两个入口返回相同的 `balance`(金额字符串,暂无数据时为 `null`)、`currency`、`stale`(是否为上次有效余额)。余额属于公司商户,不随首页日期筛选变化。WebSocket 不可用时,每 60 秒回读快照。
+`admin.stats.third_game_balance` 的事件 `data` 包含 `balance`、`currency`、`stale`,与 `GET /admin/home/third-game-balance` 的 `data` 相同。见[商户余额字段定义](../../后台首页第三方游戏商户余额-前端接入.md)。
 
 平台统计的 `wechat` 已包含在 `mobile` 中。订单角标沿用原接口的近 24 小时口径;`agentRecharge`、`agentApplication`(代理申请待审核)、`agentPlanApplication`(合营方案申请待审核)、`shareClaim` 统计全部待处理、不限申请日期。代理三项仅在代理表已迁移时返回。权限分别沿用 `admin/online/platformCount` 和 `admin/paymentOrder/unProcessed`。
 

+ 10 - 12
docs/前端交付/后台首页第三方游戏商户余额-前端接入.md

@@ -1,23 +1,21 @@
 # 后台首页第三方游戏商户余额
 
-首页新增「第三方游戏商户余额」卡片,显示公司商户当前余额,独立于首页日期筛选。
+余额为公司第三方游戏商户账户的最近一次有效余额,与首页日期筛选无关。
 
-## 初次读取
+## HTTP
 
-沿用后台登录态,进入首页时请求 `GET /admin/home/third-game-balance`,直接读取 `data`。
+`GET /admin/home/third-game-balance` 使用后台登录鉴权,无请求参数。
 
 ```json
 {"code":0,"data":{"balance":"1234.5600000000","currency":"CNY","stale":false}}
 ```
 
-| 字段 | 展示规则 |
-|---|---|
-| `balance` | 金额字符串。`null` 显示「—」,金额为零时显示 `0` |
-| `currency` | 币种,例如 `CNY` |
-| `stale` | `true` 时保留金额并显示「暂未刷新,显示上次余额」 |
+| 字段 | 类型 | 含义 |
+|---|---|---|
+| `balance` | `string` 或 `null` | 最近一次查询成功的金额,尚无成功记录时为 `null` |
+| `currency` | `string` | 币种,例如 `CNY` |
+| `stale` | `boolean` | 有历史金额且最近一次余额刷新失败,或距上次成功已满 120 秒时为 `true`。尚无成功记录时为 `false` |
 
-## 实时更新
+## WebSocket
 
-订阅私有频道 `admin.stats.third_game_balance`,监听 `stats.updated`(直接用 Echo 时为 `.stats.updated`)。用 `event.data` 替换余额数据,字段与 HTTP `data` 相同。
-
-余额或失效状态变化时才推送。需重新同步时调用同一 GET,WebSocket 不可用时每 60 秒回读一次。离开首页时取消订阅和定时器。
+私有频道为 `admin.stats.third_game_balance`,事件名为 `stats.updated`。事件 `data` 与 HTTP 响应的 `data` 字段相同,数据变化时推送。

+ 1 - 1
docs/总后台/后台实时推送-前端接入.md

@@ -302,7 +302,7 @@ Echo 回调收到的对象:
 | `admin.stats.platform_count` | `total`、`apple`、`android`、`pc`、`mobile`、`wechat`、`unknown` |
 | `admin.stats.unprocessed` | `usdtRecharge`、`rgRecharge`、`rmbRecharge`、`usdtWithdraw`、`rgWithdraw`、`rmbWithdraw`、`agentRecharge`、`agentApplication`、`agentPlanApplication`、`shareClaim` |
 
-首页先用 `GET /admin/home/third-game-balance` 获取快照,再订阅 `admin.stats.third_game_balance` 的 `stats.updated`。两个入口返回相同的 `balance`(金额字符串,暂无数据时为 `null`)、`currency`、`stale`(是否为上次有效余额)。余额属于公司商户,不随首页日期筛选变化。WebSocket 不可用时,每 60 秒回读快照。
+`admin.stats.third_game_balance` 的事件 `data` 包含 `balance`、`currency`、`stale`,与 `GET /admin/home/third-game-balance` 的 `data` 相同。见[商户余额字段定义](../前端交付/后台首页第三方游戏商户余额-前端接入.md)。
 
 平台统计的 `wechat` 已包含在 `mobile` 中。订单角标沿用原接口的近 24 小时口径;`agentRecharge`、`agentApplication`(代理申请待审核)、`agentPlanApplication`(合营方案申请待审核)、`shareClaim` 统计全部待处理、不限申请日期。代理三项仅在代理表已迁移时返回。权限分别沿用 `admin/online/platformCount` 和 `admin/paymentOrder/unProcessed`。