API 集成中心完整指南

API 集成中心是 DSP 平台统一的 API 资产管理与开放治理 模块，覆盖 API 注册、分类与参数、调用方与凭证、授权与策略、路由与上游、调用监控与审计、对接文档导出等能力。

典型场景：

• 将内部或第三方 HTTP 接口登记为平台 API 资产并发布；
• 为合作方创建调用方、发放 AK/SK 或 Token，并配置授权与白黑名单；
• 为高频接口配置限流、熔断、降级策略；
• 通过调用日志与监控分析排查联调问题。

访问入口

使用前准备

1. 已登录 DSP，且账号具备 API 集成中心访问权限。
2. 明确待登记接口的 编码、URL、请求方法、协议（http/https）。
3. 若需开放给外部系统：提前确定 调用方编码、认证方式（AKSK / TOKEN 等）。
4. 后端 api-center 服务已部署（概览指标、分页列表可正常加载）。

页面由 顶部概览区 与 下方 Tab 工作区 组成。

API 资产

功能说明：维护平台对外暴露的 API 元数据，是后续授权、路由、策略的关联主体。

操作步骤：

1. 点击 Tab 「API资产」。
2. 在搜索框输入编码、名称或备注，回车或点 刷新 查询。
3. 点击 新增，在弹窗中填写字段后保存。
4. 对已有记录可 编辑、复制（生成新记录，不含接口ID）、删除。
5. 对草稿/未发布接口：确认后点 发布；对已发布接口点 下线。

主要字段：

预期结果：保存后提示「已保存」；发布/下线后列表状态更新，概览指标刷新。

注意事项：发布、下线、删除均有二次确认弹窗；删除不可恢复。

API 注册

功能说明：与 API 资产共用同一数据表与字段集，用于 注册视角 维护接口（界面与 API 资产一致，可按组织流程区分使用）。

操作同 4.1（无单独的发布/下线按钮时，以资产 Tab 为准）。

API 分类

功能说明：为 API 建立分类树，便于检索与权限划分。

操作步骤：新增 → 填写父分类ID、编码、名称、所属应用 → 保存。

主要字段：分类ID（只读）、父分类ID、编码、名称、所属应用 appCode、备注。

API 参数

功能说明：为指定 apiId 维护请求/响应参数定义。

主要字段：参数ID、接口ID、编码、名称、类型、默认值、备注。

调用方

功能说明：登记调用 API 的系统或应用（内部、OpenAPI、合作伙伴）。

主要字段：

凭证

功能说明：为调用方配置 AK/SK、Token 等认证信息。

主要字段：调用方ID、认证方式（AKSK/TOKEN/DSP_TOKEN/INTERNAL）、AccessKey、Secret（仅保存时提交）、Token、过期时间、状态。

注意：Secret、Token 仅在保存时提交，列表不回显明文。

授权

功能说明：建立调用方与 API 的允许/拒绝关系及有效期。

主要字段：调用方ID、接口ID、授权类型（ALLOW/DENY）、开始/过期时间、状态。

策略

功能说明：按 API 或调用方配置限流、配额、熔断、降级。

策略类型 policyType：RATE_LIMIT、QUOTA、CIRCUIT、DEGRADE；配合时间窗口、调用次数、失败阈值、降级内容等字段。

白黑名单

功能说明：按 IP、用户、组织、应用等维度限制访问。

主要字段：名单类型（ALLOW/DENY）、目标类型（IP/USER/ORG/APP）、目标值。

路由

功能说明：将对外路径映射到上游服务，配置方法、优先级、超时。

主要字段：路由编码/名称、接口ID、路径、方法、上游ID、优先级、超时(ms)。

上游服务

功能说明：定义后端服务集群的基础地址与健康检查。

主要字段：上游编码/名称、服务编码、协议、基础地址 baseUrl、健康检查路径。

上游实例

功能说明：在上游服务下维护具体主机、端口、权重与健康状态。

调用日志

功能说明：查询历史调用记录，用于联调与故障排查。

主要列：Trace ID、接口编码、调用方ID、请求路径、状态码、耗时、是否命中限流/熔断。

监控分析

功能说明：按分钟聚合的调用量、成功率、耗时等指标。

审计记录

功能说明：记录配置变更类操作，满足合规审计。

对接文档

功能说明：查看已生成的 API 文档快照（Markdown / OpenAPI JSON），支持复制。

操作步骤：

1. 切换到 「对接文档」 Tab。
2. 搜索 API 编号、应用或接口ID，点击 刷新。
3. 在左侧表格 点击一行，右侧显示预览。
4. 在 Markdown / OpenAPI 子 Tab 间切换查看。
5. 点击 复制 Markdown 将文档复制到剪贴板（提示「已复制」）。

场景 A：开放单个 API 给合作方

1. API资产：登记接口并 发布。
2. API参数：补充入参定义（可选）。
3. 调用方：新建合作方，类型 PARTNER。
4. 凭证：为其配置 AKSK 或 TOKEN。
5. 授权：ALLOW 关联该 apiId。
6. 路由 + 上游服务/实例：配置真实转发路径。
7. 策略：按需设置限流；白黑名单 限制来源 IP。
8. 合作方联调后，在 调用日志、监控分析 中验证。

场景 B：接口下线与紧急熔断

1. 在 API资产 对目标接口执行 下线。
2. 或在 策略 配置 CIRCUIT / DEGRADE，观察 监控分析 中熔断次数。

场景 C：导出对接说明

1. 完成资产发布与参数维护。
2. 在 对接文档 选择快照，复制 Markdown 或查看 OpenAPI 提供给调用方。

• 需登录访问；菜单是否显示由角色 资源分配 控制。
• 凭证 Secret、Token 仅创建/更新时提交，注意最小权限原则。
• 发布范围 publishScope 影响可见范围（PRIVATE/ORG/PUBLIC）。