WonderableAI/shaguabijia-app-server
11
0
Fork 0
Code Issues Pull Requests 14 Actions Packages Projects Releases Wiki Activity

docs: 新建 docs/integrations 集成层文档 + api 文档变薄

Browse Source 
- 新增 docs/integrations/(README + jiguang/sms/meituan/pangle/wxpay 各一篇):
  记录各 SDK 集成的签名/验签/加解密/协议细节与踩坑(对齐 app/integrations 分层)
- docs/api 接口文档变薄: 受影响接口头部加「集成实现」链接,把验签/RSA/CPS 签名
  等重逻辑描述移到集成文档;ad-pangle-callback 验签段精简为指针
- docs/api/README 补架构说明(api 薄 / 重逻辑在 integrations)
- 后端技术实现.md 目录树补全(福利/钱包/签到/省钱/发奖端点 + crud/integrations 现状),
  pangle/wxpay 标注移入 integrations
- ad_reward_golive_checklist 路径同步 core→integrations

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
OuYingJun1024
2026-05-27 20:45:12 +08:00
parent 6f2731ee2d
commit 3d1e8969e6
21 changed files with 293 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/README.md
+1
View File
@@ -4,6 +4,7 @@
> 协议:HTTP / JSON,请求与响应体均 `application/json`,字段统一 **snake_case**
> 鉴权:需鉴权的接口在请求头带 `Authorization: Bearer <access_token>`
> 最后更新:2026-05-27
> 架构:`app/api/v1/` 只放很轻的接口层;穿山甲/微信支付/极光/短信/美团等 SDK 集成的重逻辑在 `app/integrations/`,实现细节见 [docs/integrations/](../integrations/README.md)。
---
docs/api/ad-pangle-callback.md
+24 -12
View File
@@ -1,28 +1,40 @@
# GET /api/v1/ad/pangle-callback — 穿山甲激励视频发奖回调(S2S)
# GET /api/v1/ad/pangle-callback — 穿山甲 GroMore 激励视频发奖回调(S2S)
> 所属:Ad 组（前缀 `/api/v1/ad`） | 鉴权:**无 JWT,靠验签**（穿山甲服务器调用） | 限流:同 IP ≤300 次/分 | [← 返回 API 索引](./README.md)
> 所属:Ad 组（前缀 `/api/v1/ad`） | 鉴权:**无 JWT,靠验签**（穿山甲 GroMore 服务器调用） | 限流:同 IP ≤300 次/分 | [← 返回 API 索引](./README.md)
>
> ⚠️ 我们客户端用 `useMediation(true)`(GroMore 融合),回调走 **GroMore 广告位层级**(规范见 supportcenter/26240),**不是**联盟代码位层级(5416)。两者密钥、响应格式都不同,别混。后台配置入口:**GroMore 聚合管理 → 搜广告位ID → 编辑 → 勾选「服务端激励回调」**(广告位层级配了就别再在代码位层级重复配,会冲突)。
>
> 集成实现:见 [integrations/pangle](../integrations/pangle.md)（验签算法、m-key 来源、设计动机）。
## 入参（query，由穿山甲拼装）
穿山甲在激励视频播完后回调,带一组 query 参数,关键:
## 入参（query，由 GroMore 拼装）
GroMore 以 GET 回调,关键参数:
| 字段 | 类型 | 说明 |
|---|---|---|
| `user_id` | string | 客户端起播时传入的用户标识（须为数字 = 本系统 user.id） |
| `trans_id` | string | 穿山甲交易号（**幂等键**） |
| `sign` | string | 穿山甲签名（用 `PANGLE_REWARD_SECRET` 验） |
| `reward_name` | string | 奖励名（可选,入库备注） |
| … | | 其余参与签名的参数 |
| `user_id` | string | 客户端 `setUserID` 传入的用户标识（须为数字 = 本系统 user.id） |
| `trans_id` | string | 交易号（**幂等键** + **唯一参与签名的字段**） |
| `reward_name` | string | 奖励名（广告位配置,入库备注） |
| `reward_amount` | int | 奖励数量（广告位配置）→ **本次发放金币**。缺/坏/≤0 回退 `AD_REWARD_COIN`,超 `MAX_AD_REWARD_COIN` 夹紧 |
| `extra` | string | 客户端透传的 customData（可空,入库备注） |
| `mediation_rit` | string | 代码位 ID（GroMore 带,目前仅入 raw 备查） |
| `prime_rit` | string | 广告位 ID（同上） |
| `adn_name` | string | 实际出广告的 ADN 名（同上,可用于收益分析） |
| `ecpm` | string | 本次广告 eCPM（同上,可用于收益分析） |
| `sign` | string | 签名,见下 |
**验签**:`sign = SHA256("{m-key}:{trans_id}")` 十六进制（只签 `trans_id`，其余参数不参与）。算法细节、m-key 来源、为什么这样设计 → 见集成文档 [integrations/pangle](../integrations/pangle.md)。
## 出参
响应 `200`:`PangleCallbackOut`
响应 `200`,**响应体必须是 `{"is_verify": bool, "reason": int}`**（GroMore 规范）。
| 字段 | 类型 | 说明 |
|---|---|---|
| `is_valid` | bool | `true`=已受理（发奖成功 或 当日达上限 或 user 非法,均不让穿山甲重试） |
| `is_verify` | bool | `true`=校验通过、发放奖励（发奖成功 或 当日达上限,均算已处理、不重试） |
| `reason` | int | `is_verify=false` 时的错误码,透传客户端 SDK:`1`=参数缺/坏,`2`=user 不存在;成功为 `0` |
## 错误码
- `403` 验签失败（`bad sign`,留给真请求重试）
- `503` 回调未配置（`pangle_callback_configured=false`）
## 说明
**发奖唯一可信入口**:验签 → 取 `user_id`/`trans_id` → 幂等发金币（按 `trans_id` 去重 + 每日上限）。客户端不参与发奖,被破解也刷不到钱。验签过但参数缺/坏或 user 不存在 → 受理但不发（`is_valid` 仍据情况返回,避免无意义重试）。
**发奖唯一可信入口**:验签 → 取 `user_id` → 按 `reward_amount` 解析金币 → 幂等发金币（按 `trans_id` 去重 + 每日上限）。客户端不参与发奖,被破解也刷不到钱。验签过但参数缺/坏或 user 不存在 → 不发（`is_verify=false` + `reason`）;granted / capped → `is_verify=true` + `reason=0`。
docs/api/auth-jverify-login.md
+3 -1
View File
@@ -1,6 +1,8 @@
# POST /api/v1/auth/jverify-login — 极光一键登录
> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:无 | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/jiguang](../integrations/jiguang.md)（极光核验链路、RSA 解密策略、私钥配对踩坑）。
## 入参
@@ -17,4 +19,4 @@
- `403` 账号被禁用
## 说明
后端拿 `login_token` 调极光 `loginTokenVerify` 验真 → 取回 RSA 加密的手机号 → 用私钥解密 → 注册即登录（手机号不存在则建号）→ 签发 JWT。
后端验真 `login_token` 取回并解密手机号 → 注册即登录（手机号不存在则建号）→ 签发 JWT。极光核验 + RSA 解密的实现细节见 [integrations/jiguang](../integrations/jiguang.md)。
docs/api/auth-sms-login.md
+2
View File
@@ -1,6 +1,8 @@
# POST /api/v1/auth/sms/login — 手机号 + 验证码登录
> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:无 | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/sms](../integrations/sms.md)（验证码校验逻辑）。
## 入参
docs/api/auth-sms-send.md
+2
View File
@@ -1,6 +1,8 @@
# POST /api/v1/auth/sms/send — 发送短信验证码
> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:无 | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/sms](../integrations/sms.md)（mock 模式、频控、接真供应商 TODO）。
## 入参
docs/api/meituan-coupons.md
+2
View File
@@ -1,6 +1,8 @@
# POST /api/v1/meituan/coupons — 券列表 / 搜索
> 所属:美团 CPS 组（前缀 `/api/v1/meituan`,**全部无鉴权**） | 鉴权:无 | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/meituan](../integrations/meituan.md)（CPS S-Ca 签名、入参换算坑）。
## 入参
docs/api/meituan-feed.md
+2
View File
@@ -1,6 +1,8 @@
# POST /api/v1/meituan/feed — 首页混合推荐流
> 所属:美团 CPS 组（前缀 `/api/v1/meituan`,**全部无鉴权**） | 鉴权:无 | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/meituan](../integrations/meituan.md)（CPS S-Ca 签名、入参换算坑）。
## 入参
docs/api/meituan-referral-link.md
+2
View File
@@ -1,6 +1,8 @@
# POST /api/v1/meituan/referral-link — 换取推广链接
> 所属:美团 CPS 组（前缀 `/api/v1/meituan`,**全部无鉴权**） | 鉴权:无 | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/meituan](../integrations/meituan.md)（CPS S-Ca 签名、入参换算坑）。
## 入参
docs/api/wallet-bind-wechat.md
+2
View File
@@ -1,6 +1,8 @@
# POST /api/v1/wallet/bind-wechat — 微信授权 code 换 openid 并绑定
> 所属:Wallet 组（前缀 `/api/v1/wallet`） | 鉴权:Bearer | 限流:同 IP ≤10 次/分 | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/wxpay](../integrations/wxpay.md)（code 换 openid / userinfo）。
## 入参
docs/api/wallet-unbind-wechat.md
+2
View File
@@ -1,6 +1,8 @@
# POST /api/v1/wallet/unbind-wechat — 解绑微信(清空 openid)
> 所属:Wallet 组（前缀 `/api/v1/wallet`） | 鉴权:Bearer | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/wxpay](../integrations/wxpay.md)。
## 入参
无（用户由 token 确定）。
docs/api/wallet-withdraw-info.md
+2
View File
@@ -1,6 +1,8 @@
# GET /api/v1/wallet/withdraw-info — 提现额度 / 绑定状态
> 所属:Wallet 组（前缀 `/api/v1/wallet`） | 鉴权:Bearer | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/wxpay](../integrations/wxpay.md)（提现链路）。
## 入参
无（用户由 token 确定）。
docs/api/wallet-withdraw-status.md
+2
View File
@@ -1,6 +1,8 @@
# GET /api/v1/wallet/withdraw/status — 查提现单状态(轮询)
> 所属:Wallet 组（前缀 `/api/v1/wallet`） | 鉴权:Bearer | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/wxpay](../integrations/wxpay.md)（查单 / 撤销转账）。
## 入参（query）
docs/api/wallet-withdraw.md
+2
View File
@@ -1,6 +1,8 @@
# POST /api/v1/wallet/withdraw — 发起提现到微信零钱
> 所属:Wallet 组（前缀 `/api/v1/wallet`） | 鉴权:Bearer | 限流:同 IP ≤20 次/分 | [← 返回 API 索引](./README.md)
>
> 集成实现:见 [integrations/wxpay](../integrations/wxpay.md)（微信 V3 商家转账、签名、实名加密）。
## 入参