> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-55d9d317.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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=f53a2779dc9e83f8250e97426b9d59cc" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=977b7c52759645a67f1d8b83fa08d22e" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d8f3df9c9cc793605af6c55dc4b65636" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=e8d7887e30d038eaaf36a43000db69aa 280w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=693e9d292cdc6e12f8d938f0f7050f9a 560w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=2d4f5063345589279ce21b6cb0c378b0 840w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=ed549d6637a30e2aee0d25257ca322a8 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=fa364c0bf3e008f8abf0ab4af5e3c295 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d1c886a84679d7c33ef59a5d9a520f0e 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=cc19090779583f81661a7d8f9a810fea" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=53b73c4393c2cd377d79aa095dc18b57" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=57fc2dea63566ade7f35daa353cff6e0 280w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=c24384a96b2fef48a84f53bee9f2bc70 560w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=b1f5d02f802bf8c5aa34dfaf6df1ee66 840w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=3c9c3ac415919b049af4e22360391648 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=5f2347fe6eefe582763c61a3aaaaaaa6 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=6c9662295ac496af00ade257b02c7f62 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=e41bcb0056f3b327224b262c7a0c9527" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d1c39911a167434f63a3f8ce7d4876f3" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=78c0753393c1d08da1074c694d69b257" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=a0121ff2e764a7dafdc9d2ec7f7603b7" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=3e88a45897fa4fe0335b5d4166507a87" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=1016682b22b9f744825fefceef436319" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=9a6366dea1c2fb515cd4e98e19781ec2" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=7a3647286a741cf48c43ea364da99051" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=8b406c77099ec3528f04a4ad90ac419c" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=acfd69542be767fef0993d87dfe66743" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=04bd7250960e7f3e0d895f982c013914" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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