API介绍

介绍

从0.2.0版本开始，系统提供了Open API接口，主要用于自动化测试后，将测试结果转化为缺陷，持续跟踪管理。

如何调用

第三方软件可通过Http接口形式访问系统，系统中为不同接入方提供一个密钥，每次调用，需在Header头中加入此密钥，如下形式所示：

var myHeaders = new Headers();
myHeaders.append("CAT2BUG-API-KEY", "202402110748485l2ug97j471ul9wq");
myHeaders.append("User-Agent", "Apifox/1.0.0 (https://apifox.com)");
myHeaders.append("Accept", "*/*");
myHeaders.append("Host", "127.0.0.1:2020");
myHeaders.append("Connection", "keep-alive");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("http://127.0.0.1:2020/api/defect", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

上面调用接口代码中的第二行，就是我们提到的API密钥，调用接口时，必须以CAT2BUG-API-KEY为名称，它的值是在系统中申请获取的。

提示

每个API密钥只对一个项目有效

创建密钥

在项目设置中，选择API KEY，进入密钥设置界面。密钥可以设置失效，当失效过期后，密钥将无法使用。