文档目录

开放基座总览

开放基座是元序平台的开放门户,通过API目录、版本治理、OAuth2授权接入、限流保护与调用审计,解决平台能力开放、API管理混乱和生态无法建立的问题。

  • API目录统一暴露平台能力,支持在线调试
  • 多版本并存,废弃前6个月通知,平滑迁移
  • OAuth2授权接入,权限由认证基座控制
  • 按应用/租户/IP多维度限流,防止过载
  • 完整调用审计日志,每次调用可追溯

从平台到生态——API 目录、版本治理、第三方应用接入、限流与调用审计一应俱全。自主不等于封闭,可控基础上的开放,才是大平台的气度。

十二基座之中,开放基座是"国门"。它确保元序不是封闭的孤岛,而是可以生长出合作伙伴生态的开放大陆。


一、为什么需要开放基座

1.1 平台开放的三大困境

在平台开放过程中,面临三个系统性的困境:

困境一:平台能力无法对外开放。

元序有 12 个基座、7 台引擎、57 个能力模块——这些能力很强大,但都是封闭的。第三方开发者无法调用这些能力,无法在元序上开发插件和扩展。

困境二:API 管理混乱。

API 版本混乱——v1/v2/v3 并存,不知道哪个版本是最新的;API 文档不全——开发者不知道有哪些接口,不知道接口怎么用;API 没有保护——没有限流,没有审计,被恶意调用也不知道。

困境三:生态无法建立。

元序是一个封闭的平台,没有合作伙伴生态。客户想要一些个性化功能,只能找元序官方开发,周期长、成本高。

1.2 开放基座的定位

开放基座在元序体系中的定位:

基座职责类比
引擎基座生产软件核心组件生产线
能力基座提供标准件库零部件仓库
开放基座API 目录、版本治理、第三方接入国门

开放基座的价值在于:作为元序的"国门",确保元序不是封闭的孤岛,而是可以生长出合作伙伴生态的开放大陆——自主不等于封闭,可控基础上的开放,才是大平台的气度。


二、核心能力详解

2.1 API 目录

所有基座和引擎的能力以标准 RESTful API 对外暴露,附完整文档。

API 目录是开放基座的基础能力,它让开发者可以方便地发现和使用平台能力:

  • 标准 RESTful API:所有 API 遵循 RESTful 设计规范,统一接口风格;
  • 完整文档:每个 API 都有完整的文档(接口说明、参数说明、返回值说明、示例代码);
  • 在线调试:开发者可以在 API 文档站在线调试接口,不需要搭建本地环境;
  • API 搜索:支持按关键词搜索 API,快速找到所需接口。

API 目录的价值:开发者在 API 文档站浏览所有可用接口,在线调试——从"不知道有哪些接口"到"一目了然"。

2.2 版本治理

API 版本管理:v1/v2/v3 并存,平滑迁移。

版本治理是开放基座的关键能力,它让 API 版本管理变得有序可控:

  • 多版本并存:v1/v2/v3 可以并存,老版本不会突然下线;
  • 平滑迁移:v2 接口废弃前 6 个月发布通知,v3 上线后 v2 继续服务;
  • 版本切换:开发者可以自主选择使用哪个版本的 API;
  • 废弃提醒:即将废弃的 API 会提前提醒开发者迁移。

版本治理的价值:v2 接口废弃前 6 个月发布通知,v3 上线后 v2 继续服务——开发者有充足时间迁移,不会突然中断。

2.3 第三方接入

第三方应用通过 OAuth2 授权接入元序生态。

第三方接入是开放基座的核心能力,它让合作伙伴可以在元序上开发插件和扩展:

  • OAuth2 授权:第三方应用通过 OAuth2 授权接入,安全可控;
  • 权限控制:第三方应用的权限由认证基座严格控制,只能访问被授权的数据;
  • 应用审核:第三方应用需要通过安全审核才能上架到应用市场;
  • 应用市场:第三方应用可以上架到应用市场,供客户选购。

第三方接入的价值:ISV 开发了一个"智能排班"插件,通过开放基座接入元序——客户可以在应用市场选购这个插件,快速获得个性化功能。

2.4 限流保护

按应用/租户/IP 设置调用频率限制,防止过载。

限流保护是开放基座的保障能力,它确保平台不被恶意调用或过载:

  • 多维度限流:按应用/租户/IP 设置调用频率限制;
  • 自动降级:超出限流阈值自动降级,返回友好提示;
  • 动态调整:根据平台负载情况动态调整限流阈值;
  • 黑白名单:支持设置黑白名单,对特定应用特殊处理。

限流保护的价值:某第三方应用限流 100 次/分钟,超出自动降级——防止平台被恶意调用或过载。

2.5 调用审计

每次 API 调用记录完整日志:谁调的、调了什么、结果如何。

调用审计是开放基座的关键能力,它让每次 API 调用都可追溯、可审计:

  • 完整日志:每次 API 调用记录完整日志——谁调的、调了什么、结果如何、耗时多少;
  • 快速定位:排查"数据泄露"嫌疑 → 审计日志显示某应用调用了 10 万次客户查询;
  • 异常检测:自动检测异常调用模式(如短时间内大量调用),及时告警;
  • 合规审计:审计日志满足合规审计要求。

调用审计的价值:排查"数据泄露"嫌疑 → 审计日志显示某应用调用了 10 万次客户查询——每次调用都可追溯、可审计。

2.6 开发者门户

为合作伙伴提供一站式开发者体验:文档、SDK、沙箱、社区。

开发者门户是开放基座的扩展能力,它让合作伙伴的开发体验变得简单友好:

  • 文档中心:完整的 API 文档、开发指南、最佳实践;
  • SDK 下载:提供多种语言的 SDK(Java、Python、JavaScript、Go);
  • 沙箱环境:提供沙箱环境,合作伙伴可以在沙箱中开发测试;
  • 开发者社区:开发者可以交流经验、提出问题、获得支持。

开发者门户的价值:合作伙伴在开发者门户注册 → 获取 API Key → 在沙箱测试 → 上线——一站式开发者体验。


三、开放基座的核心价值

3.1 量化价值

指标传统方式开放基座提升幅度
API 发现不知道有哪些接口API 目录,一目了然从未知到可知
API 版本管理版本混乱,突然下线多版本并存,平滑迁移从混乱到有序
第三方接入无法接入OAuth2 授权,安全可控从封闭到开放
API 保护无限流,被恶意调用多维度限流,自动降级从无保护到有保护
调用审计无审计,无法追溯完整日志,可追溯审计从黑盒到透明

3.2 定性价值

  • 促进生态繁荣:合作伙伴可以在元序上开发插件和扩展,丰富平台功能;
  • 降低开发成本:客户可以通过应用市场选购第三方插件,不需要定制开发;
  • 提升平台价值:平台因生态而繁荣,合作伙伴因平台而成长;
  • 保障安全可控:OAuth2 授权、限流保护、调用审计,确保开放安全;
  • 提升开发者体验:文档、SDK、沙箱、社区,一站式开发者体验。

四、数据资产沉淀

4.1 开放基座的资产化

开放基座的每一次使用,都在沉淀可复用的数字资产:

资产类型来源价值
API 文档API 目录API 文档的积累,可跨版本复用
第三方应用第三方接入第三方应用的积累,形成应用生态
调用数据调用审计API 调用数据的积累,可用于分析优化
开发者经验开发者门户开发者经验的积累,形成最佳实践

4.2 资产的四层沉淀

API 开放 ──→ 文档沉淀 ──→ 应用生态 ──→ 最佳实践
   ↓            ↓            ↓            ↓
  原始积累     结构化沉淀    生态化繁荣    标准化复用
  • 第一层:API 开放——每次 API 开放产生的文档和日志;
  • 第二层:文档沉淀——将 API 文档沉淀为标准文档;
  • 第三层:应用生态——第三方应用的积累,形成应用生态;
  • 第四层:最佳实践——行业标杆客户的开放经验。

五、开放基座与其他基座的关系

开放基座是元序生产体系的国门,与其他基座的关系:

所有基座 ──能力暴露──→ 开放基座(所有基座的能力通过 API 对外开放)
开放基座 ──第三方接入──→ 认证基座(第三方应用通过认证基座鉴权)
开放基座 ──调用记录──→ 系统基座(API 调用纳入统一监控)
开放基座 ──生态扩展──→ 能力基座(第三方开发的能力可注册为标准件)
开放基座 ──API 调用──→ AI 基座(AI 能力通过开放基座对外开放)

协同案例:智能排班插件

  • 开放基座提供 API 目录,ISV 发现元序有"员工管理""考勤管理"等 API;
  • 开放基座通过 OAuth2 授权,ISV 开发"智能排班"插件;
  • 认证基座控制插件的权限,只能访问被授权的数据;
  • 系统基座监控插件的 API 调用,确保不超限;
  • 能力基座将插件注册为标准件,供其他客户使用;
  • 开放基座将插件上架到应用市场,供客户选购。

一个插件,多个基座协同——API 开放、OAuth2 授权、权限控制、调用监控、标准件注册、应用市场上架。


六、实施建议

6.1 分阶段上线策略

阶段目标重点
第一阶段(1~2周)API 目录上线梳理核心 API,建立 API 文档站
第二阶段(3~4周)版本治理上线建立 API 版本管理规范,启用多版本并存
第三阶段(1~2月)第三方接入上线启用 OAuth2 授权,建立开发者门户
第四阶段(持续)限流保护与调用审计启用限流保护和调用审计,持续优化

6.2 关键成功因素

  • API 设计:遵循 RESTful 设计规范,确保 API 质量;
  • 文档质量:确保 API 文档完整、准确、易懂;
  • 安全保障:启用 OAuth2 授权、限流保护、调用审计;
  • 生态运营:积极运营开发者社区,吸引合作伙伴。

七、结语

开放基座让元序从"一个平台"进化为"一个生态"——合作伙伴在元序的土壤上生长,元序因生态而繁荣。

开放基座的价值不仅在于对外开放 API,更在于让元序从封闭的平台进化为开放的生态——合作伙伴可以在元序上开发插件和扩展,客户可以通过应用市场选购第三方插件。

API 目录、版本治理、第三方接入、限流保护、调用审计、开发者门户——六大核心能力,构成元序生产体系的"国门"。开放基座确保元序不是封闭的孤岛,而是可以生长出合作伙伴生态的开放大陆。

这就是开放基座的战略意义:让元序从"一个平台"进化为"一个生态"——自主不等于封闭,可控基础上的开放,才是大平台的气度。