公开API

Bitdefender 控制中心 API允许开发者实现业务流程自动化

这些API通过 JSON-RPC 2.0协议 进行暴露

以下是通过API调用更新 控制中心 :

{
        "id": "91d6430d-bfd4-494f-8d4d-4947406d21a7",
        "jsonrpc": "2.0",
        "method": "updateCompanyDetails",
        "params": {
            "name": "我的公司名称"
        }
    }

该调用会向应用程序返回以下响应

{
        "id":"91d6430d-bfd4-494f-8d4d-4947406d21a7",
        "jsonrpc":"2.0",
        "result": null
    }

每个API调用都针对一个方法并传递一组参数。

参数分为两种类型：

API调用通过HTTP请求执行，以JSON-RPC消息作为负载。每个API调用必须使用HTTP POST方法。此外，每个HTTP请求必须设置 Content-Type 请求头为 application/json .

控制中心 提供针对产品不同领域的多个API。每个API公开一组与指定产品领域相关的方法。

所有API的基础URL为： CONTROL_CENTER_APIs_ACCESS_URL/v1.0/jsonrpc/ 。API的完整URL通过将API名称附加到基础URL获得。

该 CONTROL_CENTER_APIs_ACCESS_URL 显示在 访问URL 字段。要找到该字段，请点击 控制台右上角的用户图标并选择 我的账户 。进入 控制中心 API部分 .

当前开放的API如下：

可通过向每个API URL发起包含JSON RPC 2.0的HTTP请求来调用已开放的功能。

API密钥是在 我的账户 的 控制中心 部分生成的唯一密钥。每个API密钥允许应用程序调用一个或多个API公开的方法。允许访问的API需在生成密钥时进行选择。

生成API密钥步骤：

1. 使用管理员账户登录 https://gravityzone.bitdefender.com/ 。该账户需具备以下权限： 管理网络 , 管理用户 , 管理公司 以及 查看与分析数据 .

2. 点击控制台右上角的用户名并选择 我的账户 :

   

3. 进入 API密钥 部分，点击 添加 按钮：

   

4. 输入密钥描述并选择要为此密钥启用的API：

   

5. 点击 生成 .

   注意

   将显示一个包含新生成API密钥的窗口及警告信息，提示该密钥仅在窗口打开时可查看。关闭窗口后，您将无法在 GravityZone .

   

6. 点击 按钮将密钥复制到剪贴板并保存至安全位置。

7. 关闭 API密钥 窗口。

新密钥将以模糊形式添加到 API密钥 区域，同时显示其描述、创建日期及已启用的API列表。

控制中心 还允许您删除不再需要的API密钥：

对 控制中心 的API调用在HTTP协议层通过 HTTP基本认证 机制进行验证，具体描述 见此处 .

客户端应用程序每次调用API时都需要发送Authorization请求头。

该 Authorization 请求头包含以下要素：

控制中心 当请求的API方法无法执行预期任务时将返回错误。

以下是API调用失败的错误响应示例：

{
          "id":"4d77e2d9-f760-4c8a-ba19-53728f868d98",
          "jsonrpc" : "2.0",
          "error" : {
              "code" : -32601,
              "message" : "方法未找到",
              "data" : {
                  "details" : "所选API不可用。"
              }
          }
      }

错误代码和错误信息按照 JSON-RPC 2.0规范 :

完整的错误描述存放在 data.details 错误信息的成员中。

此外，HTTP状态码会根据错误类型设置：