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. 「アカウント」 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 をメモします。次の API でその ID を使用する必要があります。
      応答本文から ID をコピーします
  4. アプリケーション・インベントリー・ファイルを、次の手順でインポートします。
    1. Applications API を展開し、「POST /api/v4/Apps/ImportFile」をクリックします。
      「Implementation」セクションには、ファイルに組み込む属性のタイプを把握するためにダウンロードできるサンプル・ファイルがあります。
    2. ステップ 3d の assetGroupId を「パラメーター」セクションの Value フィールドに入力します。
    3. uploadedFile セクションの「参照」をクリックして、インポートするアプリケーションの CSV ファイルを見つけます。
    4. 「実行」をクリックします。
      次のように正常にインポートされたことが示されます:成功したアプリケーションのインポート

例

REST API を使用した結果を含む、スキャン・ファイルのインポート
AppScan on Cloud でスキャンを実行することなく、結果を含むスキャン・ファイルをインポートするには、次の手順に従います。
  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 とその他の必須パラメーターがマップされていることを確認してください。