跳转到正文

开发需求管理

维护开发需求、处理版本冲突,并通过统一 SSO 接入需求开放接口。

两端通用文档版本 0.2.2更新于 2026-09-24

打开需求工作空间

在 Web 或桌面端打开“开发需求清单”,选择项目。需求记录属于选定项目,操作前先核对项目名称。面板右上角的“集成说明”打开本章节;桌面端会在系统浏览器打开当前环境的帮助中心。

录入和维护

根据界面字段填写需求名称、内容及相关信息。修改单元格后检查保存反馈;批量导入前查看字段映射与预览。利用筛选、排序和视图配置关注当前记录,视图改变展示方式,不代表底层记录被删除。

处理冲突

出现“记录已更新”提示时,刷新并比较最新内容,再应用自己的修改。批量操作前确认实际选中的记录范围。验收时写清触发条件、期望结果、异常处理与验收标准。

开放接口与统一 SSO

第三方沿用现有 SSO 应用和用户身份,由 SSO 证明身份、SAP Autopilot 检查项目权限。调用时携带面向本系统 API 资源的用户 Access Token:

text
Authorization: Bearer <用户 Access Token>

可以复用桌面 API 资源,不需要新建账号、API Key、额外读写 scope 或共享 OIDC_CLIENT_SECRET。不接受 ID Token、Web Cookie、第三方会话 Cookie 或请求正文中的用户标识。系统管理员在“系统配置 → 统一 SSO 与开放接口”核对桌面 API 资源(Audience);开放接口资源留空时自动复用桌面资源。两端测试和生产使用各自的接口基址与 audience。

第三方在现有 OIDC SDK 的 resources 中追加同一个 API Identifier,获取该 resource 的用户 Access Token 后由服务端调用开放 API。接口校验签名、issuer、audience 和有效期,使用 sub 识别用户、client_id 记录调用方;不支持机器身份或 client_credentials。项目成员或系统管理员沿用现有项目权限,非成员不能访问。

推荐路径是“第三方页面 → 第三方后端 → 开放 API”。本接口未开放跨域 CORS,不要把令牌放在 URL 或日志中。网络超时使用相同 key 重试以保持幂等;更新、删除和恢复必须提交读取到的 version,遇到 409 version_conflict 先读取最新记录再决定如何合并。

接口目录

基址为本环境的 /api/open/v1。常用接口包括:

  • GET /projects:查询当前用户有权限的项目。
  • GET /projects/{projectId}/development-requirements/metadata:读取字段、选项、成员、视图与 revision。
  • GET /projects/{projectId}/development-requirements:按 query 分页查询需求。
  • GET /projects/{projectId}/development-requirements/revision:检查清单是否变化。
  • GET /projects/{projectId}/development-requirements/records/{recordId}:读取单条记录及版本。
  • GET /projects/{projectId}/development-requirements/records/{recordId}/history:读取修改历史。
  • POST /projects/{projectId}/development-requirements:原子批量新增、修改、软删除或恢复。

请求包含业务唯一 key、reason 和 operations;同一批操作任一项失败会整体回滚。成功响应包含 records、revision 和 mutationId;错误响应包含 code、message、details 和 requestId。请求不缓存,所有响应带 X-Request-Id。