CWM API の概要
CWM API は、Representational State Transfer(REST)の設計原則に従って開発されました。API には、JSON データ形式を使用した HTTP を使用してアクセスします。関連する HTTP 応答コードで、要求の処理の成否が示されます。データ取得メソッドには GET 要求が必要です。一方、データを追加、変更、または削除するメソッドには POST、PUT、PATCH、または DELETE メソッドが必要です。要求が誤ったリクエストタイプで送信されると、エラーが返されます。
CWM API の使用方法
CWM API は次の 2 つの方法で使用できます。
-
Swagger インターフェイスを介して、または
-
Postman コレクションを介して
CWM UI からアクセスする Swagger インターフェイスが製品に直接組み込まれていますが、使いやすさを考慮して、サンプル要求を含む Postman コレクションも提供されています。
[API を介した管理(Manage via API )] セクションのすべてのチュートリアルでは、Swagger の使用を前提としています。
Swagger の使用
CWM Swagger API にアクセスするには、左側のナビゲーションメニューから、[swagger] アイコンをクリックします。
CWM Postman コレクションの使用
前提条件
-
Postman Web アプリケーションアカウントまたは Postman デスクトップがインストールされている。
JSON コレクションファイルのダウンロード
このリンクをクリックして、JSON 形式の Postman コレクションをダウンロードします。zip アーカイブを解凍します。
コレクションのインポートと環境の設定
手順
ステップ 1 |
Postman を開き、[コレクション(Collections)] に移動します。 |
ステップ 2 |
[インポート(Import)] をクリックし、[インポートするには任意の場所にドロップ(DropAnywhere to Import)] 画面からフォルダを選択し、zip アーカイブから解凍したフォルダをポイントします。 |
ステップ 3 |
[環境(Environment)] に移動し、新しくインポートしたテスト環境を選択します。 |
ステップ 4 |
CWM の IP アドレスとポートに合わせて baseUrl 変数と port 変数の現在の値を指定し、変更を保存します。 これで設定が完了し、コレクションを使用する準備が整いました。 |