API 版本

Test Manager 中的 API 版本控制，涵盖 v1 和 v2 之间基于角色的访问控制差异，以及旧版 API 可访问性。

Test Manager 提供了两个 API 版本，您可以通过这两个版本进行集成。API 的第一个版本不受基于角色的访问控制的保护。在给定项目的范围内，使用基于角色的访问控制来保护 API 的第二个版本。几个旧版 API 只能由组织管理员访问。即使项目所有者不是组织管理员，他们现在也可以访问这些 API 的第二版。

版本计划

V1 已于 2023 年 3 月 7 日弃用并删除。

基于版本的 API

API 版本	权限	描述
V1	附件• 项目（已弃用） • RedmineConnector（已弃用） • 要求（已弃用） • 服务器信息 • ServiceNowConnector（已弃用） • 设置 • 遥测 • 测试用例日志 • 测试用例 • 测试执行 • 测试集 • 测试步骤 • 第三方身份验证（已弃用） • 用户身份验证 • 用户 • 用户会话 • 用户设置WebHookConfiguration（已弃用） • XrayCloudConnector（已弃用） • XrayConnectorWebhooks • XrayServerConnector（已弃用）	适用于组织管理员和非管理员用户。 未通过基于角色的访问控制进行保护。
V2	• AzureDevOpsConnector • 连接器 • 自定义字段定义 • JiraCloudBasicAuthConnector • JiraCloudOAuthConnector • 项目权限 • 项目 • QtestConnector • 要求 • ServiceNowConnector • WebHook 配置 • XrayCloudConnector • XrayServerConnector	适用于管理员和项目所有者。

更新版本

使用 Swagger 更新 API 版本，以进行基于角色的访问调用。

1. 将/swagger/index.html添加到您的 Test Manager 实例 URL（例如https://testmanager.com/swagger/index.html）。
2. 选择页面顶部的 Select a definition（选择定义），然后从下拉列表中选择 V2。

现在，请求包含版本号，您可以在以下示例中看到。

curl -X 'GET' \
  'https://company/testmanager/companyTenant/testmanager_/api/v2/projects' \
  -H 'accept: application/json'

相关文章

• 概述