メインコンテンツまでスキップ
メインコンテンツまでスキップ

Programmatic API access with Postman

このガイドでは、Postmanを使用してClickHouse Cloud APIをテストする方法を説明します。 Postmanアプリケーションは、Webブラウザ内で使用できるほか、デスクトップにダウンロードすることもできます。

アカウントを作成する​

ワークスペースを作成する​

  • ワークスペースに名前を付け、可視性レベルを設定します。

コレクションを作成する​

  • 左上のメニューの「Explore」の下で「Import」をクリックします:
  • モーダルが表示されます:
  • 「Import」ボタンをクリックして「Postman Collection」を選択します:

ClickHouse Cloud API仕様とのインターフェース​

  • 「ClickHouse Cloud用API仕様」が「Collections」（左ナビゲーション）内に表示されます。
  • 「ClickHouse Cloud用API仕様」をクリックします。中間ペインから「Authorization」タブを選択します:

認証を設定する​

  • ドロップダウンメニューを切り替えて「Basic Auth」を選択します:
  • ClickHouse Cloud APIキーをセットアップした際に受け取ったユーザー名とパスワードを入力します:

変数を有効にする​

  • 変数を使用すると、Postman内で値を保存および再利用でき、APIテストが容易になります。

Organization IDとService IDを設定する​

  • 「Collection」内で、中央ペインの「Variable」タブをクリックします（Base URLは前のAPIインポートによって設定されているはずです）。
  • baseURLの下の「新しい値を追加」をクリックし、あなたの組織IDとサービスIDに置き換えます:

ClickHouse Cloud API機能をテストする​

「GET 利用可能な組織のリスト」をテストする​

  • 「ClickHouse Cloud用OpenAPI仕様」の下で、フォルダーを展開 > V1 > organizations
  • 「GET 利用可能な組織のリスト」をクリックし、右側の青い「Send」ボタンを押します:
  • 返された結果は、「status": 200」と共に組織の詳細を返すはずです（「status」が400で、組織情報が表示されない場合は、設定が正しくありません）。

「GET 組織の詳細」をテストする​

  • organizationidフォルダーの下に移動し、「GET 組織の詳細」へ:
  • 中央フレームのメニューのParamsにorganizationidが必要です。
  • この値を波括弧内のorgidで編集します {{orgid}}（この値を設定したことで、メニューが表示され、値が表示されます）:
  • 「Save」ボタンを押した後、画面右上の青い「Send」ボタンを押します。
  • 返された結果は、「status": 200」と共に組織の詳細を返すはずです（「status」が400で、組織情報が表示されない場合は、設定が正しくありません）。

「GET サービスの詳細」をテストする​

  • 「GET サービスの詳細」をクリックします。
  • organizationidとserviceidの値をそれぞれ{{orgid}}と{{serviceid}}に編集します。
  • 「Save」を押し、次に右の青い「Send」ボタンを押します。
  • 返された結果は、「status": 200」と共にサービスのリストとその詳細を返すはずです（「status」が400で、サービス情報が表示されない場合は、設定が正しくありません）。