跳到主要内容

API 目录与调用申请

API 目录 是统一的 对外发布接口的目录集,展示所有已发布的 API 接口,构建企业内部 API 开放生态。

API 目录

浏览与检索​

  • 分组与分类:接口按分组树 + 分类标签组织,支持关键词检索
  • 接口详情页:包含接口文档、请求/响应参数说明、认证方式与调用示例
  • 文档导出:接口详情支持导出 DOCX 文档,便于离线评审与交付

调用申请与审批​

调用方获取接口权限的流程:

  1. 在接口详情页点击 申请调用
  2. 选择要使用的应用(或新建应用)
  3. 提交申请,等待接口负责人审批
  4. 审批通过后,该接口自动授权给应用,凭证即刻可用

审批流说明:

  • 申请人可在个人中心查看申请状态或 撤销 申请
  • 审批人在个人中心处理待办(通过 / 拒绝 / 终止)
  • 支持站内消息通知未读提醒

应用与凭证​

  • 一个应用持有唯一的 AppKey / AppSecret,可被授权多个接口
  • 应用支持 启用/禁用 状态切换,禁用后所有调用被拒绝
  • 可配置 凭证 IP 白名单,收敛调用来源
  • AppSecret 泄露时可重置

认证方式详见 签名认证指南。

接口生命周期​

API 从创建到销毁的状态流转:

  • 多环境发布:开发 / 测试 / 生产环境独立发布快照
  • 版本管理:发布历史可查、可回滚、可跨环境同步
  • 接口迁移:支持迁移包导出与导入,用于跨环境/跨项目搬迁
  • 契约导入导出:工作台支持 OpenAPI 契约的预览、导入与导出(入口在工作台,不在 API Hub)

发布与迁移的完整操作见 环境与发布 与 版本迁移。