Postman REST APIクライアントの設定

Zscalerは、Postman REST APIアプリのmacOS、Windows、およびLinuxバージョンをサポートしています。アプリとその機能の詳細は、Postmanのドキュメンテーションを参照してください。

Postmanが既にインストールおよび構成されている場合は、リファレンス ガイド内の任意の記事から、ワークフロー自動化API Postmanコレクション ファイルの最新バージョンをダウンロードできます。

Postmanのインストールと設定(macOS、Windows、またはLinux用)

Postmanをインストールして設定するには、次の操作を行います。

  1. PostmanのWebサイト にアクセスし、お使いのOS(macOS、Windows、Linuxなど)用のアプリをダウンロードしてインストールしてください。
  2. インストール後、アプリを開いてアカウントにログインします。アカウントをお持ちでない場合は、アカウントを作成できます。
  3. リファレンス ガイドから最新バージョンのワークフロー自動化API Postmanコレクション ファイルをダウンロードします。
  4. メインウィンドウで、[インポート]をクリックします。あるいは、トップ メニューから[ファイル]>[インポート]に移動することもできます。

  1. 表示されるインポートのウィンドウで、.postman_collectionファイルをウィンドウにドラッグアンドドロップするか、[ファイル]をクリックしてローカルからアップロードします。

ファイルがインポートされると、新しいフォルダーワークフロー自動化API(workflow-automation-API-postman-collectionなど)が[コレクション]内に表示されます。

  1. 右上の環境ドロップダウン メニューの横で、環境なしが選択されていることを確認し、[環境のクイック ルック]アイコンをクリックします。
  2. [追加]をクリックします。

  1. 表示される[新しい環境]タブで、以下の手順を実行します。
    1. 環境用にわかりやすい名前を入力します(例、Zscalerテスト環境)。
    2. [変数]には、[URL]を入力します。
    3. タイプは、デフォルトのままにします。
    4. 初期値には、次のように入力します。 https://api.<us1.zsworkflow.net>/dlp/v1、ここで、<us1.zsworkflow.net>とは組織用にプロビジョニングされたクラウドです。
    5. [保存]をクリックします。

次に、右上のドロップダウン メニューからこの環境(例、Zscalerテスト環境)を選択できます。詳細は、Postmanのドキュメンテーションを参照してください。

Postmanでセッションを認証する

Postmanアプリのインストールと設定が完了したら、セッションの認証を試してください。

  1. API管理者の資格情報を使用してワークフロー自動化Admin Portalにログインします。詳細は、はじめにを参照してください。
  2. APIキーのページからキーIDとキーのシークレットをコピーします。
  3. Postmanアプリで、次の操作を行います。
    1. [ファイル]>[設定]に移動します。

  1. [一般]で、[SSL証明書検証]をオフにしてください。

  1. 以前にインポートしたPostmanコレクションのPOSTget-token-by-api-keyに移動します。
  2. 本文をクリックし、手順3でコピーしたkey_idkey_secretを置換します。
  3. [送信]をクリックします。

PostmanアプリのAPIキーを使用してAPIを認証するためのPOST要求のスクリーンショット

閉じる

APIキーが正しくセットアップされている場合は、認可トークンを含むステータス200 OKのメッセージが返されます。

PostmanでAPIコールを行う

Postmanを使用してAPIコールを行ってみてください。次の例では、/incidents/transactions/{transcationId}を使用して特定のDLPインシデントに関する情報をダウンロードします。

  1. 正常に認証できることを確認します。
  2. GET get-dlp-incidents-by-transaction-idにアクセスします。必ず、GET要求内の{transcationId}を実際のトランザクションIDで置換してください。

  1. 認可のタブで、タイプベアラートークンであること、および正しい認可トークンが渡されたことを確認します。
    1. 成功したAPI認証から受け取ったベアラー トークンをコピーします。
    2. ベアラートークンをトークンのフィールドに貼り付けます。

  1. [送信]をクリックします。

ステータス200 OKのメッセージと応答が表示されます。

デフォルトでは、セッションは300秒または5分後に終了します。