> ## 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 애플리케이션은 웹 브라우저에서 사용할 수 있으며, 데스크톱에 다운로드하여 사용할 수도 있습니다.

<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\&quot;를](https://api.clickhouse.cloud/v1\&quot;를) 입력하고 '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="Collection > 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>

* 이제 "ClickHouse Cloud용 API 사양"이 "Collections"(왼쪽 탐색 메뉴)에 표시됩니다.

<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" />

* "ClickHouse Cloud용 API 사양"을 클릭합니다. 가운데 창에서 '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 keys를 설정할 때 받은 사용자 이름과 비밀번호를 입력합니다:

<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>

* [변수](https://learning.postman.com/docs/sending-requests/variables/)를 사용하면 Postman에서 값을 저장하고 재사용할 수 있어 API 테스트를 더 쉽게 진행할 수 있습니다.

<div id="set-the-organization-id-and-service-id">
  #### 조직 ID와 서비스 ID 설정
</div>

* "Collection"에서 가운데 창의 "Variable" 탭을 클릭합니다(기준 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 사용 가능한 조직 목록"을 클릭한 다음, 오른쪽의 파란색 "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 조직 세부 정보" 테스트
</div>

* `organizationid` 폴더 아래에서 "GET 조직 세부 정보"로 이동합니다:
* 가운데 프레임 메뉴의 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이 표시되고 서비스 정보가 없으면 구성이 올바르지 않은 것입니다.)
