> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-parallel-read-in-order-multi-part.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", background}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  const backgroundColor = background === "white" ? "white" : background === "black" ? "rgb(31 31 28)" : undefined;
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} style={{
    backgroundColor
  }} />
      </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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=c8e937020db9cbeb341e57f69afbe920" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=20f172c520195fd8765db38699b08557" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=0d7cf5d604f168200fd44c87c21c2a93" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=7935a8d073a66d13c22b59fbc1943724 280w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=081dd4846e5281e9825306401f9b189e 560w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=b086f4647269d3eb61be3185e5fc2131 840w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=cd90c4cc515c1b8af9fbdb22017eafae 1100w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=15239ca9ca59d503882a61eeb1917b3b 1650w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=bbd521efcbec31bbfe77ad2e7a91cdcb 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=f21c7d1d6a313693bfd50eb86edb85e9" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=da347bbae0e723d993e1ec7942f24012" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=905bd0cbf854a0e9b0e6febe98f7696d 280w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=159c9001ccdf50fc880e67992edaa4d1 560w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=0145439294707be76f54f010809c15ae 840w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=9873c7564a21cb701205f926baace2e5 1100w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=c378e5b6fec0ce84078d53671067c39c 1650w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=7e0c328fa37df6d70eca4e9cecd612ac 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=fa3ef8614b84236050dd2f4531bec9c1" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=d7104587d6a337dd04a7e7ab4a15d34a" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=6581c0f5e7fe44162f0d95d8a553c320" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=97afcc2d52737e087489fcf76a32d6b1" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=970afdc12491a881270e45c8f4b1ac33" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=dc538af249a056314f77dea0b106b641" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=75c0776048221c335cc3a8e9ee937f6c" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=ebdee2d84ca99cb63d8a432163472e25" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=6d88e7d64cbc4ab3cbdd7de899f898a4" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=4266e7bc1c49a7b2db84f24eca977d6b" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=7e9862e776047e8008a380d9e7234f95" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

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