> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-67bc7bf8.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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=29a723988ebfd50b8d39a82f6b13fae8" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=5f92a02b1b1a92b00af693bb7050f532" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=4e45550dfecad0e7cb216855171b207a" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=f3459ab7b2c5be5f870a4c4026fa3022 280w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=6b849de23b6f7ee04b99a435620748d7 560w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=72d9d5789ab76e610330e99923b50d32 840w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=22b842dd7d56eb8ffb1c276e439f8794 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=908a1d2fe333e1b50a0cd03eac19d8e9 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=611546c0c4fe4714bb5f27dafcde2b67 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=714a938e9f373f3c0616c6c0296ea837" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=08f1f59775df64f86d9a8a2bc8a7bbb8" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=a9a40b7443b4276bbaffa1bb4ca8dc01 280w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=52fdb2396ce1de5d4a14141c38907aa7 560w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=f45ef8dd6b1198156ddecfba476571fe 840w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=466257384ab1c103fb4420f234fbcdf5 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=24bfa4b8f8d1f9fabece44106ad4658e 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=7fbb2d36420c6b8b87146cfbba0dfd66 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=3185bb7d31b3894b9951404eb16ff2be" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=305e250a2e991b1fe71451272cddf8c6" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=e4f382922730eced8f94164344407db1" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=181425b2acf079cb049f2b36680a7d3b" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=af644f92ef9902cfeb0e35b5134f77c0" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=41b45fcc77450954fb851204eb6b534b" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=2946977c68a89ca6bcc6a26198779d5b" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=be257f14e173bba53241925a81916b81" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=8e158caf4bcfecf64225c22e4f54a278" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=f89c36cba25250a74606dcbb44db6d9d" 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-67bc7bf8/rN0GAKCa2MML40yO/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=rN0GAKCa2MML40yO&q=85&s=18000ec0082a590187bd5e84f0b45f21" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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