[go: up one dir, main page]
メインコンテンツまでスキップ
メインコンテンツまでスキップ

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

このガイドは、Postmanを使用してClickHouse Cloud APIをテストするのに役立ちます。 Postmanアプリケーションは、ウェブブラウザ内で使用可能で、デスクトップにダウンロードすることもできます。

アカウントを作成する​

Postman site

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

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

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

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

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

  • 「ClickHouse CloudのAPI仕様」が「Collections」（左ナビゲーション）内に表示されます。
Import your API
  • 「ClickHouse CloudのAPI仕様」をクリックします。中央のペインで「Authorization」タブを選択します：
Import complete

認証を設定する​

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

変数を有効にする​

  • 変数を使うことで、Postman内で値を保存し再利用でき、APIテストが簡単になります。

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

  • 「Collection」の中で、中央のペインの「Variable」タブをクリックします（Base URLは先ほどのAPIインポートで設定されています）：
  • baseURLの下で、「Add new value」と表示されたフィールドをクリックし、組織IDとサービスIDを置き換えます：
Organization ID and Service ID

ClickHouse Cloud API機能のテスト​

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

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

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

  • organizationidフォルダ内で、「GET 組織の詳細を取得」に移動します：
  • 中央のフレームメニューのParamsにorganizationidが必要です。
Test retrieval of organization details
  • この値を中括弧{{orgid}}に置き換えます（以前にこの値を設定したため、値が入ったメニューが表示されます）：
Submit test
  • 「Save」ボタンを押した後、画面右上の青い「Send」ボタンを押します。
Return value
  • 返される結果には、あなたの組織の詳細が「status": 200」とともに返されるはずです。（「status」が400で、組織情報が無い場合は、設定が正しくありません）。

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

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