> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=cd64b7a8997b32455e21d87347e7895e" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=e2e60b7203d278cde33e431d2f57d2ac" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=6af713ac842fde01ce4f51cb29629d97" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=a3d406757a0b395df92b561c27c8fa29 280w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=161a544e5c915fc4923e61c85c2547f3 560w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=e2fef9caae857762c3ec15bfa67b7a73 840w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=5f9d599b37571dd5f6f0870396f5455a 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=f215292f9d938a55b4a29ac51075a19f 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=682c8198c200d505b83ff5343454fcff 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=28b5c3455257083cc711ad9102dbe153" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=f7e303f5a1b8d637ecd301e4b8ed4d2c" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=f13e49457b33d6dc520054db56637d20 280w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=448e49069f47a57a2b097591adf18a92 560w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=1c48156ccdcabd2fa7c045befc0510c7 840w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=245840f709f18d64a59a19920cab7674 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=910fa98f3d13a23d490818a5f4b9d994 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=0f831a84921f572b902d5d0d35487647 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=1b8a8395893ec9d5702d8e9f1e03a47d" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=d6077045eb8b35ff2e023ce9d08c89d5" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=08f0165a9ad27201f6c07c93073d6577" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=d0778903d4153d3f80e3658798b4cb52" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=764147c7812ab3f324df7e76e30fcd85" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=244f15d5f7df55b2eda0fd93f8ee4b57" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=9ab7ab440ea7a5c04c0e2d0e672a5bfd" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=0924e4c9cab8b9dcfd3165eb2601b471" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=c08756b1935ad5ad70418a5930a9be24" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=e2542bd14226695787dbf0b62ce16741" 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-fbfa8bee/fnZpjDPmkG606nII/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=fnZpjDPmkG606nII&q=85&s=dd439c223276ee3d3b02f6f4883f8256" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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