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. 請記下「回應主體」區段中的 ID；您必須在下一個 API 中使用該 ID。
      從回應主體複製 ID
  4. 匯入應用程式庫存檔：
    1. 展開應用程式 API，然後按一下 POST /api/v4/Apps/ImportFile。
      在「實作」區段中，有一個範例檔案可供下載，讓您瞭解要併入您檔案的屬性類型。
    2. 將步驟 3d 的 assetGroupId 輸入「參數」區段的 Value 欄位。
    3. 按一下 uploadedFile 區段中的「瀏覽」，以尋找要匯入的應用程式 CSV 檔。
    4. 按一下「執行」。
      系統會顯示如下所示的成功匯入：應用程式匯入成功

範例

使用 REST API 匯入掃描檔案，包括其結果
您可以匯入掃描檔案（包括其結果）但不在 AppScan 360° 執行掃描。請按下列步驟操作：
  1. 確認您已使用以下 API 登入 Swagger：api/v4/Account/ApiKeyLogin。
  2. 使用以下 API 上傳掃描檔案：api/v4/FileUpload；然後記下「FileId」供稍後使用。例如，

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

  3. 展開「掃描」API，然後按一下 POST /api/v4/Scans/Dast。更新下列參數，以僅產生報告而不執行掃描。
    1. 「ScanOrTemplateFileId:」：更新在步驟 2 複製的「FileId」。

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

    2. 「TestOperation」：將此項設定為 ReportOnly

      "TestOperation": "ReportOnly"

    註： 請確定您已將 AppID、ScanName 及其他必要參數對應完成，才能執行 API POST /api/v4/Scans/Dast。