メインコンテンツへスキップ
メインコンテンツへスキップ

Postman を使ったプログラムによる API アクセス

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

アカウントを作成する​

Postman サイト

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

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

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

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

ClickHouse Cloud API spec を利用する​

  • 「API spec for ClickHouse Cloud」が「Collections」（左ナビゲーション）内に表示されます。
API のインポート
  • 「API spec for ClickHouse Cloud」をクリックし、中央ペインの「Authorization」タブを選択します:
インポート完了

認証を設定する​

  • ドロップダウンメニューを開き、「Basic Auth」を選択します:
Basic auth
  • ClickHouse Cloud API キーを設定したときに受け取った Username と Password を入力します:
認証情報

変数を有効にする​

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

Organization ID と Service ID を設定する​

  • コレクション内で、中央ペインの「Variable」タブをクリックします（Base URL は先ほどの API インポートによって設定されています）:
  • baseURL の下の「Add new value」と表示されている空欄をクリックし、自分の Organization ID と Service ID に置き換えて入力します:
Organization ID と Service ID

ClickHouse Cloud API 機能のテスト​

「GET list of available organizations」のテスト​

  • 「OpenAPI spec for ClickHouse Cloud」の下で、フォルダ > V1 > organizations を展開します
  • 「GET list of available organizations」をクリックし、右側の青い「Send」ボタンを押します:
組織の取得テスト
  • レスポンスには "status": 200 とともに、ご利用の organization の詳細が返されるはずです（"status" 400 が返り、organization 情報が含まれていない場合は、設定が正しくありません）。
ステータス

「GET organizational details」のテスト​

  • organizationid フォルダの下で、「GET organizational details」に移動します:
  • 中央のフレームの Params メニューで、organizationid が必須項目です。
組織詳細の取得テスト
  • この値を、波括弧付きの {{orgid}} に編集します（前の手順でこの値を設定している場合、その値を選択できるメニューが表示されます）:
テスト送信
  • 「Save」ボタンを押した後、画面右上の青い「Send」ボタンを押します。
返却値
  • レスポンスには "status": 200 とともに、ご利用の organization の詳細が返されるはずです（"status" 400 が返り、organization 情報が含まれていない場合は、設定が正しくありません）。

「GET service details」のテスト​

  • 「GET service details」をクリックします
  • organizationid と serviceid の値を、それぞれ {{orgid}} と {{serviceid}} に編集します。
  • 「Save」を押し、その後右側の青い「Send」ボタンを押します。
サービス一覧
  • レスポンスには "status": 200 とともに、ご利用のサービス一覧とその詳細が返されるはずです（"status" 400 が返り、サービス情報が含まれていない場合は、設定が正しくありません）。