docs: 更新接口接入与环境配置说明

This commit is contained in:
yelan
2026-09-01 10:14:23 +08:00
parent 40cd313786
commit 8b4b9d031d
4 changed files with 37 additions and 5 deletions

View File

@@ -1,2 +1,3 @@
VITE_APP_NAME=medical-sign-patient
VITE_API_BASE_URL=/api
VITE_USE_MOCK=true

View File

@@ -54,6 +54,19 @@ Vant、Zod、PDF 预览、第三方签名组件和自动化测试暂不接入;
患者端应采用移动优先设计,按钮、文字和签名区域需要适合老年患者使用。
## API 接入
开发环境默认使用 `/api`,由 `vite.config.ts` 代理到 `https://ipad.shenynet.com`;生产环境需要由 Nginx 或医院网关配置同路径反向代理。
已接入的真实接口:
- `POST /api/v1/sign-deliveries/token/consume`:消费短信/二维码一次性签署 Token
- `POST /api/v1/sign-deliveries/{taskId}/signature`:以 `multipart/form-data` 上传真实 PNG 签名和签署元数据。
真实流程会在进入页面时消费 Token并在提交时携带 `deliveryId``uploadToken` 和幂等键。Token 消费接口目前只返回投递凭证,不返回正式文书内容,因此真实模式会停在安全提示页,不会让患者在未阅读正式文书时提交签名。待后端提供患者端文书读取接口后,再接入 PDF/文书展示和正式提交闭环。
默认 `VITE_USE_MOCK=true` 时可以无 Token 演示完整页面交互;联调真实 Token 流程时设置 `VITE_USE_MOCK=false`,或直接使用带 `token`/`signToken`/`t` 查询参数的签署链接。
## 与医护端的关系
医护端创建签署任务patient-h5 完成签署,后端统一保存结果:
@@ -67,4 +80,4 @@ patient-h5 不直接访问医院完整电子病历。
## 当前状态
已完成 Vite 基础初始化、路由、签署流程状态管理和第一版移动端页面骨架。当前流程使用演示数据,尚未接入真实 Token 校验、文书接口和签署提交接口
已完成 Vite 基础初始化、路由、签署流程状态管理和第一版移动端页面骨架。Mock 模式可以演示完整交互;真实模式已经接入一次性 Token 消费和 PNG 签名上传请求,并增加路由保护、重复提交保护和服务端结果展示。正式文书公开读取接口尚未提供,因此真实模式暂不会进入签署步骤