REST API

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

このタスクについて

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

手順

  1. 「ツール」 > 「API」を選択します。
  2. ページの右側にある「Swagger」リンクをクリックします。Swagger に自動的にログインします。
  3. 資産グループを、次の手順で作成します。
    1. Asset Groups API を展開し、「POST /api/v4/AssetGroups」をクリックします。
    2. "string" パラメーターに資産グループの名前と説明を指定します。引用符はそのまま保持します。資産グループ API の作成
    3. 「実行」をクリックします。
    4. 「Response Body」セクションで ID をメモします。次の API でその ID を使用する必要があります。
      応答本文から ID をコピーします
  4. アプリケーション・インベントリー・ファイルを、次の手順でインポートします。
    1. Applications API を展開し、「POST /api/v4/Apps/ImportFile」をクリックします。
      「Implementation」セクションには、ファイルに組み込む属性のタイプを把握するためにダウンロードできるサンプル・ファイルがあります。
    2. ステップ 3d の assetGroupId を「パラメーター」セクションの Value フィールドに入力します。
    3. uploadedFile セクションの「参照」をクリックして、インポートするアプリケーションの CSV ファイルを見つけます。
    4. 「実行」をクリックします。
      次のように正常にインポートされたことが示されます:成功したアプリケーションのインポート

例

REST API を使用した結果を含む、スキャン・ファイルのインポート
AppScan 360° でスキャンを実行することなく、結果を含むスキャン・ファイルをインポートするには、次の手順に従います。
  1. API: api/v4/Account/ApiKeyLogin を使用して Swagger にログインしていることを確認してください。
  2. API: api/v4/FileUpload を使用してスキャン・ファイルをアップロードし、後で「ファイル ID」を保存します。例えば、以下のようにします。

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

  3. 「スキャン」 API を展開し、「POST /api/v4/Scans/Dast」をクリックします。スキャンを実行することなく、レポートだけ生成するには、次のパラメーターを更新します。
    1. ScanOrTemplateFileId:: 手順 2 でコピーした 「ファイル ID」 を更新します。

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

    2. TestOperation: これは次のようにセットします。 ReportOnly

      "TestOperation": "ReportOnly"

    注: API POST/api/v4/SCANS/DAST を実行するため、AppID、ScanName とその他の必須パラメーターがマップされていることを確認してください。