REST API

內建的 REST API 介面可讓您將 RESTful Web 服務視覺化。API 文件是使用 Swagger 來建置的，可讓您測試 API 作業並立即檢視結果，來協助您更快速地掃描應用程式。

開始之前

重要： REST API v4 現已推出！

我們很高興宣佈正式發行 REST API 4 版，此版本能帶給您更好的效能和增強的功能。對於使用自動化指令碼在 AppScan on Cloud 上執行各種不同工作的使用者來說，這個 API 可說是一款重要工具。

重點：

  1. 轉換期：目前的版本 v2 在未來幾個月內仍會維持正常運作。不過，我們鼓勵使用者主動更新指令碼，以利用 API v4 全新的改良功能。

  2. 移轉協助：若要順利轉換至更新的 API，請參閱我們提供的技術概觀，其中包含各項重要資訊與指引，可確保移轉處理程序順暢無礙。

  3. API v2 可用性：API v2 在 2024 年 7 月 30 日之前均可正常使用。我們將舊版本可用性延長的目的，是要讓使用者有足夠的時間移轉至 API v4。如果您是透過自動化指令碼使用 API，請確保已備妥移轉計劃，以避免在指定日期之後運作中斷。

執行這項作業的原因和時機

遵循這個範例，使用 /api/v4/Apps/ImportFile REST API 來匯入應用程式庫存，以瞭解如何使用互動式架構。

程序

  1. 移至 Swagger 頁面並將其加入書籤供日後參考：
  2. 使用您的 IBM ID 登入 Swagger。
    1. 展開帳戶 API，然後按一下 POST api/v4/Account/ApiKeyLogin 以展開作業詳細資料。
      顯示使用 API 金鑰登入的 POST API
    2. 以您的 API 金鑰 ID 與 API 金鑰密碼取代 "string" 參數。保留引號。
    3. 按一下「執行」。
    4. 從「回應主體」複製 "Token" 值。顯示記號的回應主體
    5. 將它貼至 Swagger 介面頂端的「存取記號」欄位。
      從現在起，記號會自動套用到所有 API 呼叫。
  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. 按一下「執行」。
      系統會顯示如下所示的成功匯入：應用程式匯入成功