REST API

組み込みの REST API インターフェースは、RESTful Web サービスを視覚化する方法を提供します。API 資料は Swagger を使用して作成されています。この資料を使用すると API 操作をテストしてすぐに結果を確認できるので、アプリケーションをより迅速にスキャンできます。

始める前に

重要: REST API v4 を使用できるようになりました。

REST API バージョン 4 がリリースされ、パフォーマンスが向上し、機能が強化されました。この API は、AppScan on Cloud でさまざまなタスクを実行するために自動化スクリプトを採用しているユーザーにとって重要なツールです。

キー・ポイント:

  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. HCL ID を使用して Swagger にログインします。
    1. 「Account」 API を展開し、「POST api/v4/Account/ApiKeyLogin」をクリックして、操作の詳細を展開します。
      API キーでのログインを表示している POST API
    2. "string" パラメーターを API キー ID と API キーの秘密に置き換えます。引用符はそのまま保持します。
    3. 「実行」をクリックします。
    4. 「Response Body」から "Token" 値をコピーします。トークンを表示している応答本文
    5. Swagger インターフェースの上部にある「Access token」フィールドにその値を貼り付けます。
      今後は、すべての API 呼び出しにそのトークンが自動的に適用されます。
  3. 資産グループを、次の手順で作成します。
    1. Asset Groups API を展開し、「POST /api/v4/AssetGroups」をクリックします。
    2. "string" パラメーターに資産グループの名前と説明を指定します。引用符はそのまま保持します。資産グループ API の作成
    3. 「実行」をクリックします。
    4. 「Response Body」セクションの ID をメモしておきます。この ID は次の API で必要になります。
      応答本文から ID をコピー
  4. アプリケーション・インベントリー・ファイルを、次の手順でインポートします。
    1. Applications API を展開し、「POST /api/v4/Apps/ImportFile」をクリックします。
      「Implementation」セクションには、ファイルに組み込む属性のタイプを把握するためにダウンロードできるサンプル・ファイルがあります。
    2. ステップ 3d の「assetGroupId」を「Parameters」セクションの Value フィールドに入力します。
    3. 「uploadedFile」セクションの「Browse」をクリックして、インポートするアプリケーションの CSV ファイルを見つけます。
    4. 「実行」をクリックします。
      インポートが成功すると、次のようになります:成功したアプリケーションのインポート