> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-postgresql-tls-support.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 = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

このガイドでは、[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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=2c61508912bc3427c876288254997bb3" size="md" alt="Postman サイト" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.webp" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=89622748f40c1941e50adeed4a81a38d" size="md" alt="ワークスペースを作成する" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.webp" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a273aaf7b93f95ebcef61e11409f6434" 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.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=9f47683f18070b76cb940e34cca4d928 280w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=e81a2184eeaf653d7372d493f599bae4 560w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f16fa40356648571f749a4b5707d187f 840w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=9aa34f9b826f5b5c5c97c48afe894813 1100w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a0bae9c821215eb338109bf377983244 1650w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=7f335120223de12613bcd20c19cf1afe 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f5d40c45499eefccf3587e7186845b82" size="md" alt="API URL入力" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.webp" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a4669236c1c9c9a202f754f84d143276" size="md" alt="コレクション > Import" border data-og-width="666" width="666" data-og-height="253" height="253" data-path="images/cloud/manage/postman/postman6.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=bd61cc099cacc518f8b98f644b803d8a 280w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=5125e8451c84e7ca9a6bf04d08de3315 560w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=3430f02f162f8022fb32265d89c0adbb 840w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a33a2aef04da985b28321e76d81c0499 1100w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=89b961ef83d6617643a54b1a4a6bae5b 1650w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=c0fed80b77456329a1e57bf3938cdcc9 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=812230ab7ce9bfadfddb8b953b82d8df" size="md" alt="APIをインポートする" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.webp" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=bb01720945db4154d083fd6875df2a4b" size="md" alt="インポート完了" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.webp" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f323d24ee610a1a5e4245315ef3ebab4" size="md" alt="Basic auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.webp" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=0eb078fcbf831047fdb7dce17abf2d59" size="md" alt="認証情報" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.webp" />

<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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=1c3eca5c4968569221ccf58e517abd3a" size="md" alt="組織 ID とサービス ID" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.webp" />

<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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=e49bb059e4cfd74a723921eef5806cb3" size="md" alt="組織の取得をテストする" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.webp" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f79579cbf02220bf0e616273cce74216" size="md" alt="ステータス" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.webp" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=091a3bbb2db96383507e7f72981496b5" size="md" alt="組織の詳細の取得をテスト" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.webp" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a5400155eba7b9ca0fdd12a27e1b9c22" size="md" alt="テストを送信" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.webp" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=5a014d30a4b683e360fc9b30c45abc73" size="md" alt="戻り値" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.webp" />

* 返された結果には、"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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=c94295e0a6c7cd5ac8e5cde7e8b94052" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

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