> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-6feb4c13.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman を使用した API へのプログラムアクセス

> このガイドでは、Postman を使用して ClickHouse Cloud API をテストする方法を紹介します

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

このガイドでは、[Postman](https://www.postman.com/product/what-is-postman/) を使って ClickHouse Cloud API をテストする方法を紹介します。
Postman アプリケーションは、Web ブラウザで利用することも、デスクトップ版をダウンロードして利用することもできます。

<div id="create-an-account">
  ### アカウントを作成する
</div>

* 無料アカウントは [https://www.postman.com](https://www.postman.com) で作成できます。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=edcab99aa0fafddd9a48e2a084beb3bf" size="md" alt="Postman サイト" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.png" />

<div id="create-a-workspace">
  ### ワークスペースを作成する
</div>

* ワークスペースに名前を付け、公開範囲を設定します。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=c7151e6e04a5f99b26033a395f0ff233" size="md" alt="ワークスペースを作成する" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.png" />

<div id="create-a-collection">
  ### コレクションを作成する
</div>

* 左上のメニューで、"Explore" の下にある "Import" をクリックします:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=11fcfeb2e6c564c20b1d5949661ae574" size="md" alt="Explore > Import" border data-og-width="1317" width="1317" data-og-height="647" height="647" data-path="images/cloud/manage/postman/postman3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=9001c52d6ace577a11fa35a089248d5d 280w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=86b2776195ec88f96b886ff59ee1aceb 560w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=f79c4e5114ed2452b4922de9e671aad1 840w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=c25d7a6d52bc56873ea59f4d1d89d369 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=6e8550608e13727b4b66422446f9aa2c 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=f11dbb516d3245498abd53018f79295c 2500w" />

* モーダルウィンドウが表示されます:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=c40202ddbee444c104de3a0e7811b645" size="md" alt="API URL入力" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.png" />

* API アドレス "[https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1)" を入力して、'Enter' キーを押します:

* "Import" ボタンをクリックして、"Postman Collection" を選択します:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=b32f1d2d3e5cfa24c7c23c8d8c957cbe" size="md" alt="コレクション > Import" border data-og-width="666" width="666" data-og-height="253" height="253" data-path="images/cloud/manage/postman/postman6.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=d29ad30b7eb7841d74c779d02b78cc33 280w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=2aa8a8eeaa79979594fbf9f9e6e53310 560w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=52e91c99a46b64e4b90a8bf3af421712 840w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=d8e2de6fbe2d492891cdf1f82943a928 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=dad1014a3e6d7a9b7be592890bc8a0ee 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=f4643e50142014c8fd241c57e072a7eb 2500w" />

<div id="interface-with-the-clickhouse-cloud-api-spec">
  ### ClickHouse Cloud API仕様を使用する
</div>

* これで、「Collections」 (左側のナビゲーション) 内に「API spec for ClickHouse Cloud」が表示されます。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=c370dd9de1470643353fdd967553dbe1" size="md" alt="APIをインポートする" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.png" />

* 「API spec for ClickHouse Cloud」をクリックします。中央のペインで「Authorization」タブを選択します。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=90cc076bcbf085a61b50c93047d18fb9" size="md" alt="インポート完了" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.png" />

<div id="set-authorization">
  ### 認証を設定
</div>

* ドロップダウンメニューを開き、「Basic Auth」を選択します。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=3a73624f8c19332f87013889531d7a65" size="md" alt="Basic auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.png" />

* ClickHouse Cloud API キーの設定時に受け取った Username と Password を入力します。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=3ce1a6d0eb6ff3010bbf5404c3f1cdce" size="md" alt="認証情報" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.png" />

<div id="enable-variables">
  ### 変数を有効にする
</div>

* [Variables](https://learning.postman.com/docs/sending-requests/variables/) を使用すると、Postman で値を保存して再利用できるため、API テストをより簡単に行えます。

<div id="set-the-organization-id-and-service-id">
  #### 組織 ID とサービス ID を設定する
</div>

* 「Collection」内で、中央ペインの「Variable」タブをクリックします (Base URL は先ほどの API インポートで設定されています) :
* `baseURL` の下にある空欄の「Add new value」をクリックし、組織 ID とサービス ID を入力します:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=ab9c22745a9385f876d7e27b13da6fa7" size="md" alt="組織 ID とサービス ID" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.png" />

<div id="test-the-clickhouse-cloud-api-functionalities">
  ## ClickHouse Cloud API の機能をテストする
</div>

<div id="test-get-list-of-available-organizations">
  ### 「利用可能な組織の一覧を取得する GET」をテストする
</div>

* 「ClickHouse Cloud の OpenAPI spec」で、フォルダ > V1 > organizations を展開します
* 「GET list of available organizations」をクリックし、右側の青い「Send」ボタンを押します。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=64850833bcfc7b0f9c03461f33376a80" size="md" alt="組織の取得をテストする" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.png" />

* 返された結果には、`"status": 200` とともに組織の詳細が表示されるはずです。 (組織情報が表示されず、`"status": 400` が返される場合は、設定が正しくありません) 。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=597e317f20c4b109adc47eace4154a79" size="md" alt="ステータス" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.png" />

<div id="test-get-organizational-details">
  ### 「GET organizational details」をテストする
</div>

* `organizationid` フォルダーで「GET organizational details」に移動します。
* 中央フレームの Params メニューでは、`organizationid` が必要です。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=4c4253bc5caa773e8376ad904793ff8f" size="md" alt="組織の詳細の取得をテスト" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.png" />

* この値を、中かっこ付きの `orgid`、`{{orgid}}` に変更します (この値を前の手順で設定していれば、その値を含むメニューが表示されます) 。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=59b79514d2bd8357e8da27c6060a1be5" size="md" alt="テストを送信" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.png" />

* 「Save」ボタンを押した後、画面右上の青い「Send」ボタンを押します。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=ce2f899cdbb51d05f4e9da2fc07b497f" size="md" alt="戻り値" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.png" />

* 返された結果には、"status": 200 とともに組織の詳細が表示されるはずです。 (組織情報が表示されず "status": 400 が返る場合は、設定が正しくありません) 。

<div id="test-get-service-details">
  ### 「GET service details」をテストする
</div>

* 「GET service details」をクリックします
* `organizationid` と `serviceid` の値を、それぞれ `{{orgid}}` と `{{serviceid}}` に編集します。
* 「Save」を押してから、右側の青い「Send」ボタンを押します。

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-6feb4c13/mvLBB3wrc6ZdAnCE/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=mvLBB3wrc6ZdAnCE&q=85&s=ea259d4508cbdf2dcdbae4281182a4c7" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

* 返された結果には、"status": 200 とともに、サービスの一覧とその詳細が表示されるはずです。 (サービス情報がなく "status" 400 が返される場合は、設定が正しくありません。)
