> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-c8329da0.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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=65d256810e670208add0334718b2eade" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=446caace67dccacb4d28b28e516d418d" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=004a2241b310b1ec8fa9722844949305" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=6ef56d6da15b1d3da7d219fe642a27f2 280w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=c40832cbbf445839ab1c9e584ac805ca 560w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=b8193a35bc84753e9f7220ba0e842905 840w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=4755e1bf325457625aa3be6fd1f09df2 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=299dd63e76da7e1dc8e2b3f8194d4ee8 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=63e44a478821e436e583620728c3d0c7 2500w" />

* 모달 창이 나타납니다:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=0bafe43b4e9d219f8fb615668b117495" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=9dc63d6d676d83f1c1137f5f8dbf7c21" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=897e27bbaa7f4e4ba4a42ee807a5d3f3 280w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=627d57d47e4e5aa4f2c08b00c1bc0577 560w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=d1b20e7204e21134a3d3604c61588498 840w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=428ef7604312c40554dcce14a7980f6a 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=6f98637ef222eb53466e5cc343b0f6b7 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=425e628b214ef48995804e431fd01ed9 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=1147b1757b75c08e52e6248a48b94efd" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=266b15b57b7799d1387f4db90322890b" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=0131d169045256ca4e9bbab96de833fb" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=139a0032880a770a7f39903c3af784ed" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=56a9bc674828b6d7731dfb450744a5e8" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=fd89d9ae629cd14ea78b68b919f0dd65" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=58e1885423c6f781bbdf85fe2272a5f9" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=8a236769bc9f1a30fafc8b1463bb4bff" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=5c14fbfecae5fc900026be98f6bee10f" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=064ff0dc0b16529dc64aca5bff2c6c89" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=d784c5cd4dbc5555b06e981dc47774b6" size="md" alt="서비스 목록" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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