REST API

内置的 REST API 接口向您提供了可视化 RESTful Web 服务的方法。API 文档可使用 Swagger 构建，在其中能够测试 API 操作并立即查看结果，从而帮助您更快地扫描应用程序。

关于此任务

通过遵循该示例来了解如何使用交互式框架来通过使用 /api/v4/Apps/ImportFile REST API 导入应用程序库存。

过程

  1. 选择工具 > API。
  2. 单击页面右侧的 Swagger 链接。您将自动登录到 Swagger。
  3. 创建资产组：
    1. 展开资产组 API 并单击 POST /api/v4/AssetGroups。
    2. 将 "string" 参数替换为资产组的名称和描述。保留引号。创建资产组 API
    3. 单击执行。
    4. 记下响应正文部分中的标识；您需要在下一个 API 中使用该标识。
      从响应正文复制标识
  4. 导入应用程序清单文件：
    1. 展开应用程序 API 并单击 POST /api/v4/Apps/ImportFile。
      在实施部分中，有一个样本文件，可下载该文件以了解文件中包含的属性类型。
    2. 在参数部分的 Value 字段中输入来自步骤 3d 的 assetGroupId。
    3. 单击 uploadedFile 部分中的浏览，找到要导入的应用程序 CSV 文件。
    4. 单击执行。
      成功导入如下所示：成功应用程序导入

示例

使用 REST API 导入扫描文件（包括结果）
您可通过以下步骤导入扫描文件（包括结果），而不在 AppScan 360° 中运行扫描：
  1. 确保您使用 API api/v4/Account/ApiKeyLogin 登录到 Swagger。
  2. 使用 API api/v4/FileUpload 上载扫描文件，并保存文件标识以备后续使用。例如，

    "FileId": "274bd3a7-a231-41d0-80f6-d22d684af50d"

  3. 展开扫描 API 并单击 POST /api/v4/Scans/Dast。更新以下参数以仅生成报告而不运行扫描。
    1. 扫描或模板文件标识：更新您在步骤 2 中复制的文件标识。

      "ScanOrTemplateFileId": "274bd3a7-a231-41d0-80f6-d22d684af50d"

    2. 测试操作：将其设置为 ReportOnly

      "TestOperation": "ReportOnly"

    注： 确保已映射 AppID、ScanName 以及运行 API POST /api/v4/Scans/Dast 所需的其他参数。