Postmanを使用したCatoサイト作成APIの利用方法

この記事では、Postman APIクライアントを使用してCatoのAPIを実行し、Cato管理アプリケーションでサイトをプロビジョンする方法を説明します。

Postmanの設定概要

これは、Catoの設定APIを実行してサイトをプロビジョンおよび更新するためのPostmanの設定についてのハイレベルな概要です。

Cato管理アプリケーションからAPIキーを生成します。
Postmanコレクションと環境をダウンロードしてインポートします。
環境を設定します。
APIを実行し、アカウントにサイトをプロビジョンします。

Cato管理アプリケーションからのAPIキーの生成

APIキーは、APIクライアントがあなたのCatoアカウントと認証するために使用するコードです。 Cato管理アプリケーションのAPI管理画面を使用して、編集権限を持つAPIキーを生成できます。

Cato作成APIのAPIキーを生成するには：

ナビゲーションメニューで、リソース > APIキーをクリックします。
APIキータブで、新規をクリックします。 APIキーの作成パネルが開きます。
キー名を入力します。
API権限を編集に設定します。
APIキーが有効期限切れになる日付を設定することをお勧めします。
適用をクリックします。 APIキーが追加され、新しいAPIキーを含むポップアップウィンドウが表示されます。
（コピー）をクリックし、Cato管理アプリケーションで生成されたAPIキーをコピーして安全な場所に保存します。

このウィンドウを閉じると、APIキーの値にアクセスできなくなります。
ポップアップウィンドウを閉じるにはOKをクリックします。

Cato APIコレクションと環境のPostmanへの追加

Cato作成APIでサイトをプロビジョンするためのカスタムPostmanコレクションと環境を作成しました。これらのカスタムファイルはCatoリポジトリで入手可能です。

_cato_env_template_.postman_environment.json
構成API用のMutation APIファイル（例：Cato Site Mutation API v1.postman_collection.json）

Postman環境には変数（API URL、CMAアカウントIDなど）が含まれており、PostmanコレクションにはGraphQL Mutation APIコールの例が含まれています。それらをインポートするには、「インポート」をクリックしてウィンドウにファイルをドロップし、インポートをクリックします：

Cato APIのコレクションと環境をPostmanに追加するには：

このKB記事からカスタムコレクションと環境をデバイスにダウンロードします。
Postmanからファイル > インポートを選択します。 インポートポップアップウィンドウが開きます。
ファイルをアップロードをクリックして、ステップ1でダウンロードしたファイルを選択します。
インポートをクリックします。

カスタム環境がPostmanの環境に表示されます：

カスタムコレクションがPostmanのコレクションに表示されます：

Postman環境の設定

各Catoテナントに対して、CMAアカウントIDとAPIキーを保存するための別々のPostman環境を使用することをお勧めします。

新しいPostman環境を作成するには：

環境タブから、テンプレート_cat_env_template_を右クリックして複製を選択します。
環境のコピーを右クリックして名前を変更を選択し、その環境をCatoテナントの名前に変更します。
APIキーとCMAアカウントIDをコピーして、環境内の該当フィールドの現在の値に貼り付け、保存をクリックします。

CMAアカウントIDはURLから直接取得できます：

サイトをプロビジョンするためのCato APIコールの実行

Postman用にAPIキーとCMAアカウントIDを定義した後

APIコールを実行してサイトをプロビジョンするには：

コレクションタブで。
右上隅で、前のステップで作成した環境を選択します。
コレクションタブから、Cato Mutation API v1 > addSocketSite > _queryを展開し、query_stateCodeを選択します。
APIコールを実行するには送信をクリックします。予想される結果は200 OKおよびいくつかのデータです。