跳至主内容
  • 云解决方案
  • 云安全API

云安全API

简介

Bitdefender的RESTful（REST）API允许开发者实现业务流程自动化。REST API通过指令获取和操作资源与数据。资源在任意时间戳的状态称为资源表征。

API调用通过携带JSON负载的GET或POST HTTP请求实现。

REST API采用由 RFC 2616 协议定义的现有HTTP方法。云安全提供两类REST API：

  • GET - 此类API可用于检索数据和资源。

    GET方法是指一种超文本传输协议（HTTP）方法，用于从特定来源请求信息。该方法也用于从一组数据中获取特定变量。HTTP POST方法则要求从供应浏览器向服务器的消息系统输入信息。超文本标记语言（HTML）结构可采用POST方法或GET方法。所采用的方法（无论是POST还是GET）决定了表单数据在服务器端如何呈现。

  • POST - 您可使用此类API创建资源。

    此方法允许数据以独立通信包的形式发送至处理脚本。这意味着通过POST方法发送的数据不会显示在URL中，因为参数不会随URI一起发送。

    HTTP POST的格式应包含HTTP标头，后接空行和请求正文。POST请求可用于提交网页表单或上传文件，但必须确保接收应用程序与所用格式兼容。Content-Type标头用于指示POST请求正文的类型。

每个API调用都针对一个端点并传递一组参数。参数分为两种类型：

  • 必选 - 必须始终传递给被调用的方法。

  • 可选 - 具有默认值，可从参数列表中省略。无论其在参数列表中的位置如何，任何可选参数均可跳过。

示例： 

GET /setting/scans/22f5ae90-f3da-4f57-9d89-0f860e******

API请求

API调用通过携带原始JSON消息的HTTP请求实现。支持GET和POST两种端点请求。

系统提供多个端点，每个端点对应产品中不同的功能区域。

所有API的基础URL因控制台不同而异：

  • 基础URL 1： 

    https://api.e.cs.gravityzone.bitdefender.com/v1/

  • 基础URL 2： 

    https://api.u.cs.gravityzone.bitdefender.com/v1

  • 基础URL 3： 

    https://api.a.cs.gravityzone.bitdefender.com/v1

获取完整API URL需遵循以下步骤：

  1. 打开新浏览器标签页并登录云安全控制台。

  2. 复制URL中从 https://api 开始到 gravityzone.bitdefender.com :

    CSPM_integrations_Jira_4_453817_en.png

  3. 将其粘贴至此模板： 

    https://api.*.**.gravityzone.bitdefender.com/v1

当前可用的API如下：

注意

云安全控制台目前不支持批量请求和通知功能。

API密钥

API密钥是在 集成 页面生成的唯一密钥，位于 云安全 控制台。每个API密钥允许应用程序调用一个或多个API公开的方法。允许访问的API在生成密钥时选定。

生成API密钥步骤：

  1. 使用管理员账号登录 https://gravityzone.bitdefender.com/ 。

  2. 进入 云安全 页面并点击 打开控制台 按钮。

    新浏览器标签页将打开，您将登录至 云安全 控制台。

  3. 在页面右上角点击 设置 按钮并选择 集成 :

    API_CSPM_setup_1_460788_en.png

    此时将显示 集成 页面。

  4. 在 API集成 部分，对于 API令牌 ，点击 创建 按钮。

    注意

    若您已创建过API密钥，该按钮将显示为 查看API令牌 .

    随后 API令牌 面板将展开。

  5. 点击面板右上角的 创建新API令牌 按钮。

    面板将显示更多详细信息。

  6. 输入用于描述该密钥用途的别名以便后续识别，随后点击 生成新API令牌 按钮：

    API_CSPM_setup_2_460788_en.png

    新生成的API密钥将显示如下：

    API_CSPM_setup_3_460788_en.png

  7. 请将该令牌复制至安全位置保存。

    重要提示

    关闭此面板后，您将无法通过云安全控制台再次查看该密钥明文。

  8. 点击 完成 .

新密钥将以模糊形式与别名一同添加到 API令牌 面板中。创建日期将显示在集成页面的 集成日期 列。

提示

仅显示最新密钥的日期。

API_CSPM_setup_4_460788_en.png

重要提示

通过使用API密钥，开发者可以访问敏感信息。请不要分享或分发您自己生成的API密钥，以防止敏感信息泄露！

在 云安全 控制台中，如果不再需要之前生成的API密钥，您也可以将其停用：

  1. 转到 集成 页面。

  2. 在 API集成 部分，对于 API令牌 ，点击 查看API令牌 按钮。

  3. 点击您希望停用的密钥对应的 停用 按钮。

    将出现确认窗口。

  4. 选择 停用 以确认请求。

    警告

    您将无法再使用这些密钥，并且使用它们的任何第三方应用连接将被终止。

状态码

当请求失败时，将返回以下错误：

错误

描述

200

成功

400

无效的查询参数。

401

API密钥未授予正确权限。

403

无效的API密钥。

404

资源路径错误。

405

方法不允许。

429

达到节流限制。

500

服务器内部错误。

本节内容 :