REST API

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

このタスクについて

以下に例示するアプリケーション・インベントリーのインポート手順に従って、対話式フレームワークの使用方法を学習します。この例では、 /api/v2/Apps/ImportFileREST API を使用します。

手順

  1. cloud.appscan.com/swagger に移動し、後で参照できるようにブックマークします。
  2. HCL ID でログインします。
    1. Account API を展開して、以下をクリックします POST api/v2/Account/ApiKeyLoginをクリックして操作の詳細を展開します。
    2. 「Example Value」ボックス内のテキストをクリックし、そのテキストを JSON オブジェクト要求として「apiKey」ボックスにコピーします。

    3. "string" パラメーターをご使用の HCL ID のユーザー名とパスワードで置き換えて (引用符は残す)、「Try it out!」をクリックします。
    4. Response Body から「Token」値をコピーします。

    5. Swagger UI の上部にある「Access token」フィールドにその値を貼り付けます。今後は、すべての API 呼び出しにそのトークンが自動的に適用されます。
  3. 資産グループを作成します。
    1. Asset Groups API を展開し、以下をクリックします。 「POST /api/v2/AssetGroups」をクリックします。
    2. IntelliJ IDEA を始動する前に、IntelliJ IDEA 環境の パラメーターセクションで、「Example Value」編集ボックス内のテキストをクリックして、テキストを JSON オブジェクト要求として「IBMIdModel」ボックスにコピーします。
    3. "string" パラメーターを資産グループの名前と説明で置き換えて (引用符は残す)、「Try it out!」をクリックします:
      資産グループ ID の取得
    4. 「Response Body」セクションの ID をメモしておきます。この ID は次の API で必要になります。
  4. アプリケーション・インベントリー・ファイルをインポートします。
    1. Applications API を展開して、以下をクリックします 「POST /api/V2/Apps/ImportFile」をクリックします。。「Implementation」セクションには、ファイルに組み込む属性のタイプを把握するためにダウンロードできるサンプル・ファイルがあります。
    2. ステップ 3d の assetGroupIdを「Parameters」セクションの「Value」フィールドに入力します。
    3. 「Browse」をクリックします。 インポートするアプリケーションのCSV ファイルを見つけます。
    4. 「Try it out!」をクリックします。
    5. 「Response Headers」セクションで、「Location」行から ID をコピーします。
      アプリケーションをインポートするためのジョブ ID
    6. API、 POST /api/v2/Apps/ImportJobs/{jobId}を展開します。
    7. ID を「jobID」フィールドに入力して 「Try it out!」をクリックします。

タスクの結果

インポートが成功すると、以下の例のようになります。
成功したアプリケーションのインポート