> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-a804b3ad.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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=cebc7a629e4e3f8190e60ef56566bbfd" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=eea5442c0b04542d4d705c585992b0e3" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=e579ae9eee204608468db336e96f6997" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=6b79e24527d9389816bbf3ecf88eeb92 280w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=48571c0230c85ad86e0205c2f6708dd4 560w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=76bdf2399545c8d9001be3193bf5eb71 840w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=3e74163d54e6baf8cfabdf227d4c1895 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=2c5e94f75a65bbd81ddfe0cba821072c 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=4fbb95d959acb31feb6a83608d4162eb 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=4a42797a9e972c2fb462141b4becf4b8" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=284de5828f673e4c1c9728e6b7c848c4" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=eec6262a41ab6007507e4c07e66d9855 280w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=267905365aa96ad14a3ab2932ff59e77 560w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=5cba1147f359d85497ec4dc920dbba3d 840w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=e7528e57c708aebb96866afc6fba5907 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=7cdd7ade637727b607002c25cda46146 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=42b2390a7f0354e342d5d70a90b7b32e 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=368ccdbccabcd94a7e92f9a3194168f6" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=908913e4cc5f91c97bda842d341efb9c" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=aa7ab3549665043384013da40d3fedd2" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=1f6b2cb5c464cdb0189e199f9cf99a82" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=6bbe23247544fcf53c82f6c4bb3639ae" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=73bb51cd49f22c6c38953d24866fdc3f" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=5bffd2af6f8f8f4462a72f2b9b449d52" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=d69fea847f33a3421a83050f126e2103" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=f88baa7bf3e84efd6437cb19b5043299" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=f419ac1903e9ec4cef40b98ccf95553b" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=d3bf719d80f4ad098ea1308e43a6a42c" size="md" alt="サービスの一覧" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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