fucai-server/api.md

59 lines
2.3 KiB
Markdown
Raw Normal View History

2025-11-14 21:51:24 +08:00
# 接口文档(活动 + OCR 领取)
## 总览
- 接口均返回 `ResultObject``{ code, msg, data }`
- 所有接口已开放匿名访问
## 当前活动
- 方法GET
- 路径:`/marriage/activity/current`
- 入参:无
- 出参:
- `data``{ activityName, activityStartTime, activityEndTime, money, status }`
- 说明:仅当当前时间处于活动开始与结束时间范围、且活动启用(`status=0`)时返回数据;否则 `data=null`
## 上传结婚证图片OCR
- 方法POST
- 路径:`/marriage/ocr/upload`
- 入参:`multipart/form-data`
- `file`:结婚证图片文件
- 出参:
- `data``{ uploadId }`
- 说明:图片内容以 Base64 暂存至 Redis`OCR_UPLOAD-{uploadId}`TTL 10 分钟)
## 发送短信验证码
- 方法POST
- 路径:`/marriage/common/sms`
- 入参:`CommSmsDTO`
- `mobile`:手机号(必填)
- `type`:验证码类型(`0` 登录;`1` 兑换领取;`2` OCR本流程使用 `3`
- 出参:`code=200`
- 说明:验证码缓存键 `VERICODE_MOBILE-{type}-{mobile}`TTL 10 分钟
## 校验短信验证码
- 方法POST
- 路径:`/marriage/common/checkCode`
- 入参JSON
- `mobile`:手机号(必填)
- `type`:验证码类型(本流程使用 `3`
- `smsCode`:短信验证码(必填)
- 出参:`code=200`(校验通过)
- 若已参与正在进行的活动,MarriageCodeVO
## 领取前校验OCR流程
- 方法POST
- 路径:`/marriage/receiveCheck2`
- 入参:`MarriageCodeDTO`
- `marriageNo`结婚证字号必填长度≥11且需符合活动条件
- `receiveName`:领取人姓名(必填)
- `receiveMobile`:领取人手机号(必填)
- `code`:核验码(必填)
- `smsCode`:短信验证码(必填,校验键 `VERICODE_MOBILE-3-{mobile}`
- `salesNo`:站点号(选填)
- `signImage`:领取人电子签名(选填,预校验阶段可为空)
- 出参:`ResultObject<MarriageCodeVO>`(用于前端预览/继续领取)
- 说明:校验重复领取、证号格式与活动条件;短信验证码校验通过后返回校验结果视图
2025-11-12 16:38:14 +08:00
本文件整理新婚送福活动前端页面所用接口包括领取流程与兑奖页面改造所需的现有接口与拟新增接口。文档基于当前代码库com-marriage-client 与 com-admin-client
2025-11-14 21:51:24 +08:00
#