> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-framing-web-ui.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 애플리케이션은 웹 브라우저에서 사용할 수 있으며, 데스크톱에 다운로드하여 사용할 수도 있습니다.

<div id="create-an-account">
  ### 계정 만들기
</div>

* 무료 계정은 [https://www.postman.com](https://www.postman.com)에서 만들 수 있습니다.

<Image img="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=d1c55981999d9c3404b11577142858f0" 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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=a4a9e16a29fbaa0b486216594856fd6c" size="md" alt="워크스페이스 만들기" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.webp" />

<div id="create-a-collection">
  ### Collection 생성
</div>

* 왼쪽 상단 메뉴에서 "Explore" 아래의 "Import"를 클릭합니다:

<Image img="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=5f16b2a2eceec65d4633f0d6aeeeb02f" 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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=d0f5de63384d47d4b38907c6831c1dc2 280w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=ed88341a270de9cf29874d017d04af18 560w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=8e72ab345cd6c381315088d4f570001f 840w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=5beb256832a89edd0478c829e0bd8ce6 1100w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=a3aca081c3f00095282abda7b54f07d3 1650w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=db317aec0ffd0792a2876406ae1d7199 2500w" />

* 모달 창이 나타납니다:

<Image img="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=376da7939fbacdc2b331cb179e034700" size="md" alt="API URL 입력" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.webp" />

* API 주소 "[https://api.clickhouse.cloud/v1\&quot;을](https://api.clickhouse.cloud/v1\&quot;을) 입력하고 'Enter'를 누릅니다:

* "Import" 버튼을 클릭하여 "Postman Collection"을 선택합니다:

<Image img="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=9c646be6cf698a06863aa7aecf684f90" 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.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=b83d46402802d4b234a23fe37b7672b4 280w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=3381c23400820cb2ffd8e3dc14c36a61 560w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=acef379a5a887ba208565688c603e8eb 840w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=47f053e97c8a883716612dffe0524597 1100w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=4771d9bd783f89a441952adbecdde358 1650w, https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=87d7a6ca82ed581838c78b3f1307fcbc 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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=69769789a50dbeefab342e36c16df21e" size="md" alt="API 가져오기" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.webp" />

* "ClickHouse Cloud용 API 사양"을 클릭합니다. 가운데 창에서 'Authorization' 탭을 선택하세요:

<Image img="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=66a2465ff4a8d431d1dea01e45b0caa3" 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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=fa33b09fc05033202cea0a2832622e6e" size="md" alt="Basic Auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.webp" />

* ClickHouse Cloud API keys를 설정할 때 받은 사용자 이름과 비밀번호를 입력합니다:

<Image img="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=c0659a2675ca38729df167c7bc0f9307" size="md" alt="자격 증명" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.webp" />

<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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=2075b97a4d8a04bf2efd6f0815fb20b1" 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 사용 가능한 조직 목록"을 클릭한 다음, 오른쪽의 파란색 "Send" 버튼을 누르십시오.

<Image img="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=ccc27a3df5a214bf301b62e136042038" 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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=38efcf4ba7e0e9a1765468ff49e6c4a9" size="md" alt="상태" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.webp" />

<div id="test-get-organizational-details">
  ### "GET 조직 세부 정보" 테스트
</div>

* `organizationid` 폴더 아래에서 "GET 조직 세부 정보"로 이동합니다:
* 가운데 프레임 메뉴의 Params 아래에서 `organizationid`가 필요합니다.

<Image img="https://mintcdn.com/private-7c7dfe99-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=318d252aca144bbfbec1efaa022a886c" 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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=af80debdaa5202730e4478042562c495" 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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=db3a599110c2c8b87ba9444a0a510f10" 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-framing-web-ui/U0HPKhAsvpqpReQJ/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=U0HPKhAsvpqpReQJ&q=85&s=2a41e050f34f0c88bebd1211feca0f2b" size="md" alt="서비스 목록" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

* 반환된 결과에는 서비스 목록과 각 서비스의 세부 정보가 "status": 200과 함께 표시되어야 합니다. ("status" 400이 표시되고 서비스 정보가 없으면 구성이 올바르지 않은 것입니다.)
