修改接口文档

This commit is contained in:
caojia
2026-09-24 17:10:06 +08:00
parent 1174dede01
commit e1e1760ab9
@@ -1,4 +1,4 @@
# TMS 订单账单状态查询接口
# TMS 订单额度欠费状态和客户状态查询接口
## 1. 接口用途
@@ -17,7 +17,7 @@ TMS 根据订单号、运单号或转单号查询 BMS 中的订单计费记录
| 字符编码 | UTF-8 |
| 响应格式 | JSON |
> `X-Api-Code` 的实际值由 BMS 管理方通过安全渠道提供,不在业务代码、接口文档或工单中明文传播。
> `X-Api-Code` = BMS.TMS.ZYaOvlQzpcfau8TUaCFfO3Hp8ieHIqGw。
## 3. 请求参数
@@ -47,6 +47,8 @@ OR transfer_no = identifier
## 4. 请求示例
按订单号查询:
```bash
curl --location \
'http://{BMS_HOST}:{PORT}/api/tms/order-bill/status?identifier=TMS20260918005496762601' \
@@ -258,4 +260,3 @@ curl --location \
5. `customerActiveStatus` 只返回 `ACTIVE`、`MISSING`、`DISABLED` 三种约定状态;只有 `ACTIVE` 表示客户当前启用,其他状态由 TMS 根据自身规则处理。
6. `creditArrearsStatus` 是订单计费记录中的状态快照,不代表客户当前实时额度状态。
7. 建议设置连接超时和读取超时,并对网络异常进行有限次数重试;查询接口本身是只读接口,可安全重试。
8. `X-Api-Code` 属于接口凭证,应通过配置中心或密钥管理方式保存,不要硬编码到 TMS 代码仓库或日志中。