数智双星
数智双星
操作指南稳定能力

API 集成中心：对接文档

完成 API 集成中心 中“对接文档”的配置、操作和结果验证。

适用：开发者、第三方集成人员阅读约 6 分钟更新于 2026-05-20
阅读本页后，你可以

完成 API 集成中心 中“对接文档”的配置、操作和结果验证。 完成本页后，你应能够理解功能边界，并按步骤完成配置和验证。

开始前检查

  • 已登录 DSP 平台并进入正确组织
  • 已选择目标应用和当前开发版本
  • 账号拥有当前功能的查看或编辑权限
功能分节界面示例
功能分节界面示例，点击可查看原图。

对接文档

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

操作步骤：

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

字段与控件说明

字段名称以当前页面显示为准。不同版本或权限下，可选项可能有所差异。

19 项
字段名称位置用途填写规则可选值影响结果常见错误
API资产Tab显示资产 ResourceTable按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
API注册Tab注册向导/列表按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
API分类Tab分类树表按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
API参数Tab参数模板列表按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
调用方Tab调用方列表按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。调用方列表若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
凭证TabAK/SK、Token 管理按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。AK/SK、Token 管理若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
授权TabAPI↔调用方授权按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。会影响用户可访问的菜单、按钮、数据范围或审批操作。若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
策略Tab限流熔断降级按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。限流熔断降级若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
白黑名单TabIP/调用方黑白名单按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。IP/调用方黑白名单若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
路由Tab路由规则按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。路由规则若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
上游服务Tab上游集群按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。上游集群若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
上游实例Tab实例节点按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。实例节点若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
调用日志Tab调用日志查询按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。调用日志查询若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
监控分析Tab指标图表按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。指标图表若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
审计记录Tab审计流水按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。审计流水若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
对接文档Tab文档导出/预览按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。文档导出/预览若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
刷新页头重新拉取概览指标卡按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。重新拉取概览指标卡若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
刷新工具栏重新分页加载按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。重新分页加载若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。
复制行操作复制为新记录（不含接口ID）按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。无固定枚举；按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。

完成标准

不要只以“按钮点击成功”作为完成依据，请至少核对以下结果。

  • 显示资产 ResourceTable
  • 注册向导/列表
  • 分类树表
  • 将内部或第三方 HTTP 接口登记为平台 API 资产并发布；
  • 为合作方创建调用方、发放 AK/SK 或 Token，并配置授权与白黑名单；

常见问题

Q12：对接文档右侧「暂无文档」？

现象选中行后 Markdown/OpenAPI 为空。

原因未生成文档快照；发布流程未触发文档同步。

处理先完成 API 发布；点击 刷新 重新拉取 listApiDocs。

继续阅读

操作指南 · 开放集成API 资产

完成 API 集成中心 中“API 资产”的配置、操作和结果验证。

操作指南 · 开放集成功能分节

了解 API 集成中心 中“功能分节”的使用方法、操作要求和完成标准。

模块指南 · 开放集成API 集成中心

API 集成中心是 DSP 平台统一的 API 资产管理与开放治理 模块，覆盖 API 注册、分类与参数、调用方与凭证、授权与策略、路由与上游、调用监控与审计、对接文档导出等能力。 典型场景： 将内部或第三方 HTTP 接口登记为平台 API 资产并发布； 为合作方创建调用方、发放 AK/SK…

操作指南 · 开放集成界面总览

了解 API 集成中心 中“界面总览”的使用方法、操作要求和完成标准。

概念说明 · 开放集成端到端场景

了解 API 集成中心 中“端到端场景”的使用方法、操作要求和完成标准。

操作指南 · 开放集成凭证

完成 API 集成中心 中“凭证”的配置、操作和结果验证。