You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

47 lines
4.6 KiB

2 days ago
# A4 客户管理
> 对应蓝湖原型「A4 客户管理」分区(A4-1 客户公海 / A4-2 客户总览 / A4-3 我的客户 / A4-4 客户详情 / A4-5 联系人 / A4-6 客户查重 / A4-7 客户交割)。
## 已落地接口(55 个 + 根级 2 个 = 57 个)
- **客户管理/**(10):新增客户、编辑客户、客户详情、客户分页、商机侧客户搜索、快速创建客户、按客户查联系人、名称相似提示、信用代码查重、工商信息查询
- **客户三 workspace/**(3):workspace 列表分页、看板分组汇总、看板单列卡片
- 对应原型 A4-1/A4-2/A4-3 三个列表页:路径段 `{workspace}` 取 mine / overview / pool 三值,一套端点三处复用
- **归属流转/**(9):领取客户、批量领取、分配客户、批量分配、抛公海、批量抛公海、归档客户、批量归档、恢复客户
- **客户详情页/**(8):详情公共头部、团队成员页签、添加团队成员、移除团队成员、关联商机页签、操作日志分页、新增跟进、跟进记录分页
- **A4-5 联系人/**(7):新增联系人、编辑联系人、删除联系人、联系人详情、顶级联系人列表、联系人全局搜索、电话软提示
- **客户关注与重点标记/**(5):关注客户、取消关注客户、标记重点客户、取消重点标记、批量关注客户
- **客户交割/**(6):发起前客户预览、发起交接、交接详情、交接记录分页、客户分配、可分配销售列表
- **客户导入/**(6):上传导入文件并预校验、确认执行导入、任务结果、失败疑似重复明细、最近导入记录、下载导入模板
- **模块健康/**(1):健康探针
- 根级 **客户管理/超期提醒规则/**(2):当前提醒规则、保存提醒规则 —— 见下「为什么超期提醒规则在根级」
示例值说明:各 .bru 的请求/响应示例均注入 **E2E 实测真值**(标注「示例数据(E2E 实测真值/实测值注入)」的为真实抓取,其余为语义兜底)。
## 为什么超期提醒规则在根级
超期提醒规则的两个端点(`GET/PUT /api/rule/customer/reminder`)实现在 **crm-rule** 模块(CustomerReminderRuleController),源码 `@Tag` 原文为「客户管理」(无 A4 前缀)。按「结构听源码」铁律,目录 = tag 原文,故其生成在 collection 根级 `客户管理/超期提醒规则/` 而非 `A4 客户管理/` 下——bruno-sync 重跑时按 tag 归位,挪进 A4 会产生孤儿目录。
## crm-preference 6 端点说明(不生成副本)
客户模块功能上依赖 crm-preference 的自定义视图(saved-view)6 个端点(列表 / 保存 / 删除 / 设为默认等),但其源码 `@Tag` 挂在 **A3 商机管理** 分区(商机先建 saved-view,客户侧复用同一套),为避免 sync 重跑产生副本/孤儿,本分区**不生成副本**,文档见 A3 分区对应目录。前端对接时 scopeKey 传 `customer.*`(如 `customer.workspace.mine`),接口本身与商机共用:
- `GET /api/preference/saved-view/list?scopeKey=customer.*`(自定义视图列表)
- `POST /api/preference/saved-view`(保存自定义视图)
- `DELETE /api/preference/saved-view/{id}`(删除自定义视图)
- `PUT /api/preference/saved-view/{id}/default`(设为默认视图)
(以上为文字索引;A3 分区文档中的 scopeKey 示例为商机域,客户域联调请按本段替换 scopeKey。)
## 空缺标注
无 —— 原型 A4 各功能页均有接口落地。已知缺口(不影响联调,详见 E2E 报告):QuickCreateDTO 无 confirmSimilar 字段、详情汇总卡 5 字段恒 null 前端显 "--"、页签 5/6 汇总卡同。
## 对接工程师示位
客户模块前端按页面目录联调:三个列表页共用「客户三 workspace/」(分页 + 看板两个子端点,路径段换 workspace);客户详情页接口集中在「客户详情页/」下(公共头部 + 6 页签共享 8 端点);联系人独立页在「A4-5 联系人/」;全生命周期归属操作(领取 / 分配 / 抛公海 / 归档等)在「归属流转/」;客户交割(总监交接)在「客户交割/」;Excel 导入全流程在「客户导入/」。
---
> 维护纪律:本 README 为人工维护的分区索引;`.bru` 接口文件由生成器依据后端 Controller tag 自动同步(只动带 `generated` 标记的文件,结构听源码、表述听人),请勿手改。各 .bru docs 首行 `METHOD path` 为对账钥匙行,**勿手改**(对账脚本以此比对源码 mapping)。agent 不执行 git 提交,由维护者审查后自行提交。