> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=e72b02c9a09b332543342a976050a598" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=422dc9b811724600a51e1d1a06d6715a" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=a7d14257917557203e22bada43717d21" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ac2f100cbe86e984d3b66a308146f0cd 280w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=542f48107296f4485736c59604593208 560w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ed138923ff712a2e09492ed31ef9edf9 840w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=f1efa5f6abd08c2e14d38cda0d4e36dc 1100w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=4b72f67d2ac0bbb25f071a3b73dbf534 1650w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ea1bce2f113aa7d3ab29fe0c78b8e353 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=38d7979ba98296590d9c876c7d6bbccb" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=6bd414437c263a49d05d55300aa41607" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=5149e81347497a0df7d06f060b99b822 280w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=7ba9aa5b66c74bee6730f21bee456316 560w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=de244832ed3f24daadd81afad9bac75e 840w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=72fa09b007806eca09e1da831735efde 1100w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=6b85cbf014b4428de85fcc4f48d2f5e6 1650w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ba79eab2e06318ccd050a81e94b9fe7e 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=f432316604acb31ef159bd741f2da343" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=c2b4bef760535aaaf9e07c87f6e82bbf" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=46e01ea2fabaf65a6da25e766da0df9e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=eaef923ed7870f4961a1eabbd833b847" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=1e0c8d519c256c952ee61ec294cc35b6" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=99392d42cebe9764355dfae7651ece65" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ad80488a9cf6ba5ba56d515f1eeb3a1e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=58f20cc3221acecc731381238beef8f5" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=d7e951fe258b988a3c81a6d8dd9c8e0e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=b9a490e9416289f5f465372cfeb910f7" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=a5f2ad863c44e1871bcb6ae45689304a" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

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