外部集成与开放 API
入向数据源、出向通道、密钥管理与接口目录
接口总数
276个
其中写接口 144 个 · 见 /api/ops/openapi.json
API 密钥
3个
启用中
2个
入向数据源
11个
API 密钥
密钥明文仅在创建时返回一次,系统只保存提示串| ID | 名称 | 应用 | 密钥提示 | 范围 | 限流 | IP 白名单 | 状态 | 调用次数 | 最后使用 | 操作 |
|---|---|---|---|---|---|---|---|---|---|---|
| AK00000003 | 门店移动端 | store-app | ak00000003-****11d8 | order:read,store:write | 300/min | 不限 | 停用 | 8642 | 2025-09-30 18:00:00 | |
| AK00000002 | BI 只读取数 | bi-prod | ak00000002-****7c21 | report:read,inventory:read | 120/min | 10.0.2.0/24 | 启用 | 42180 | 2025-10-21 02:08:00 | |
| AK00000001 | WMS 下发通道 | wms-prod | ak00000001-****3f9a | order:write,dispatch:write | 600/min | 10.0.1.0/24 | 启用 | 128430 | 2025-10-21 03:10:02 |
出向通道
| 目标系统 | 方向 | 协议 | 鉴权 | SLA |
|---|---|---|---|---|
| WMS | 下发 | HTTP + 幂等键 | API Key + HMAC | T+0,超时 30s,失败重试 3 次 |
| ERP | 下发 | MQ | mTLS | T+0,至少一次投递 |
| OMS | 双向 | HTTP | OAuth2 客户端凭证 | T+0 |
| BI | 出向 | 只读视图 | 数据库最小权限账号 | T+1 |
接口约定
统一响应体 { ok, data, meta } / { ok, error:{ code, message } }
分页 page / pageSize(≤500)
错误码 VALIDATION_FAILED / NOT_FOUND / CONFLICT / FORBIDDEN / PRECONDITION_FAILED / INTERNAL
写接口建议携带 Idempotency-Key(见幂等与写入边界)
版本策略:URL 前缀 /api/v1,旧版本保留 6 个月并提前 90 天公告
分页 page / pageSize(≤500)
错误码 VALIDATION_FAILED / NOT_FOUND / CONFLICT / FORBIDDEN / PRECONDITION_FAILED / INTERNAL
写接口建议携带 Idempotency-Key(见幂等与写入边界)
版本策略:URL 前缀 /api/v1,旧版本保留 6 个月并提前 90 天公告