公共API

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

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

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

参数分为两种类型：

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

控制中心 提供面向产品不同领域的多个API。每个API提供与特定产品领域相关的方法集。所有API的基础URL为安装 GravityZone 的主机名、域名或IP地址： https://YOUR-HOSTNAME/api/v1.0/jsonrpc/ 。获取完整API URL需在基础URL后追加API名称。

当前开放的API如下：

可通过向每个API URL发送包含JSON RPC 2.0的HTTP请求来调用其公开的功能接口。

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

生成API密钥步骤：

1. 登录 https://YOUR-HOSTNAME/ 使用管理员账户，该账户需具备以下权限： 管理网络 , 管理用户 , 管理公司 以及 查看分析数据 .

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状态码会根据错误类型进行设置：