核心概念
API:让系统按需获取数据
API 用稳定的输入参数和输出字段,让系统按条件获取已发布结果。它描述的是访问方式,不自动承诺实时数据。
系统只需要一条或少量结果时,可以按条件请求已发布数据,不必每天搬运整批文件。
API 用稳定的输入参数和输出字段,让系统按条件获取已发布结果。它描述的是访问方式,不自动承诺实时数据。
业务页面只想显示杭州分行在 2026-09-30 的存款余额。它可以发送一个带有机构和业务日期的请求:
`GET /api/deposit-balances?branch_id=HZ01&business_date=2026-09-30`。
服务返回这一条已发布记录,调用方只需要理解请求参数和响应字段,不需要知道余额在数仓里经历了哪些加工步骤。
选择机构和业务日期后发送请求,观察同一份已发布存款余额如何按条件返回为 JSON。
调用方需要知道 `branch_id` 和 `business_date` 的含义,服务方需要稳定返回 `branch_id`、`business_date`、`deposit_balance` 和 `currency`。字段名、类型和日期语义一旦随意变化,调用方就无法可靠消费。
鉴权、错误码、分页等是真实 API 通常还会考虑的内容。这里把范围收在最小的请求与响应契约内。
ads_deposit_balance_dailyGET /api/deposit-balances?branch_id=HZ01&business_date=2026-09-30{
"branch_id": "HZ01",
"business_date": "2026-09-30",
"deposit_balance": 12000000000,
"currency": "CNY"
}branch_id要查询的机构业务标识。business_date已发布日终余额所属的业务日期。稳定返回以下字段:
branch_idbusiness_datedeposit_balancecurrency这次请求返回的是 2026-09-30 的日终离线存款余额。API 描述数据访问方式,business_date 才说明结果属于哪一天;文件也不必然低频,API 也不自动实时。
真实 API 通常还会考虑鉴权、错误码和分页;本节只观察请求参数与响应契约。