v6ole
35 lines
1.8 KiB
Markdown
35 lines
1.8 KiB
Markdown
# 接口与研发云集成规范
|
||
|
||
## 触发条件
|
||
|
||
设计或审查 REST/OpenAPI、外部系统集成、研发云 SSO/OAuth、研发云 OpenAPI、数据订阅/查询/接入或脚手架服务时读取。
|
||
|
||
## 优先核验原文
|
||
|
||
- 通用接口安全：`12-security.md` 第 2 章及适用语言/Web 章节。
|
||
- 研发云范围和流程：`20-rd-cloud-overview.md` 第 4-5 章。
|
||
- SSO/OAuth 与资源授权：`21-rd-cloud-system-access-auth.md` 第 3-5 章。
|
||
- 数据订阅/查询/接入：`22-rd-cloud-data-open-access.md` 第 2-3 章。
|
||
- 研发云 OpenAPI：`23-rd-cloud-openapi.md` 第 2-3 章。
|
||
- 脚手架服务：`24-rd-cloud-scaffold-service.md` 第 3-4 章。
|
||
|
||
## 规范要求
|
||
|
||
- 明确接口负责人、调用方、数据分类、授权边界、请求/响应契约、错误行为、版本兼容、超时/重试/幂等和审计要求。
|
||
- 校验不可信输入，服务端执行授权，避免敏感输出和错误暴露，并落实原文规定的安全传输要求。
|
||
- 对研发云接口使用该接口对应的审批账号和授权模型；原文要求时分别核验项目与资产权限。
|
||
- 外部账号密钥、OAuth 客户端凭据、令牌、签名密钥和授权头不得进入代码、示例、日志或审查输出。
|
||
- 数据连接应完成原文的订阅/账号/网络前提；脚手架服务应核验时间戳、随机数/防重放、签名、回调、部署和发版关联要求。
|
||
|
||
## 工程建议
|
||
|
||
发布接口契约和变更记录，增加契约测试，并为不兼容变更指定调用方影响负责人。
|
||
|
||
## 审查证据
|
||
|
||
已批准的接口/数据契约、授权矩阵、账号/项目/资产审批、网络放通与连通性测试，以及脱敏的请求响应、审计和错误处理测试。
|
||
|
||
## 使用边界
|
||
|
||
不得把一个研发云接口的鉴权方式直接复用于其他接口；实现前必须阅读对应原文章节和当前接口文档。
|