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

PostmanによるプログラムインターフェースAPIアクセス

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

アカウントを作成する​

Postmanサイト

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

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

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

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

ClickHouse Cloud API仕様とインターフェースを取る​

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

認証を設定する​

  • ドロップダウンメニューを切り替えて「Basic Auth」を選択します：
Basic auth
  • ClickHouse Cloud APIキーを設定した際に受け取ったユーザー名とパスワードを入力します：
認証情報

変数を有効にする​

  • Variablesを使用することで、Postmanで値の保存と再利用が可能になり、APIテストが容易になります。

組織IDとサービスIDを設定する​

  • 「Collection」の中で、中央のペインにある「Variable」タブをクリックします（Base URLは先にAPIをインポートした際に設定されています）：
  • baseURLの下にあるオープンフィールド「Add new value」をクリックし、組織IDとサービスIDを代入します：
組織IDとサービスID

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

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

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

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

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

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

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