> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=a17ff568428176d30a9c8aa80133b55d" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=243d343725a3aa49c70181399c336cdd" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=42d77d7c32716e4e481bbacfb42b565d" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=e1e1159867baabde04b1a80549eaf3a1 280w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=d8e1bb3c4c741c42676a435765f6b7a3 560w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=bbf7ea77ab6fd64a112c8cfb33658165 840w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=edfbddeeb2c5245520df1e9f8e46d261 1100w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f642661811641883587cd3869581c067 1650w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=47fde21dd9031cc1738046a584204ceb 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=7a972d25323b766b3a1cd685e72d17ce" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b2f69bc914e1c62a55189d09302daac6" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=c51dbbcddbd62046357f90fbbe8b4e12 280w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=ab5c03ed0049c9afd4d25269129f358b 560w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=9fd7596109a0702b484291195e46b232 840w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b80c7029ef892192b7baaeda77d5a528 1100w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f90bbd7e34739b175e3fee4c6f34df6e 1650w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f27a3d978a3834f8ad8c24b2e5bf5978 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b6dac29e785b0ea50924d23b6b7d7769" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=d0329f48484f8e40be650a57b948d128" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=c113ffb2cf0e4f1a2ff0a29265f0805b" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b6f43307a0d912bc8051d2f2a796e7f6" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=ce74d088c994be1bae8b29d1bbacce3a" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=0743c41540a2d80a028b63d566894a7e" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=08627f71b293e5ebc3fa2d49f5b5bd91" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=7998a141ad4986a9863ad7b8f85599de" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=774209dae04db0793b5a3c98da8f2f48" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=622d3f0f5b3a7fedb95fa2448faa691c" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=78bbf324adf043fa74ce951564edb1f9" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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