> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-parallel-read-in-order-multi-part.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Программный доступ к API через Postman

> Это руководство поможет вам протестировать ClickHouse Cloud API с помощью Postman

export const Image = ({img, alt, size = "lg", background}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  const backgroundColor = background === "white" ? "white" : background === "black" ? "rgb(31 31 28)" : undefined;
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} style={{
    backgroundColor
  }} />
      </Frame>
    </div>;
};

Это руководство поможет вам протестировать ClickHouse Cloud API с помощью [Postman](https://www.postman.com/product/what-is-postman/).
Приложение Postman доступно в веб-браузере, а также его можно скачать на настольный компьютер.

<div id="create-an-account">
  ### Создайте аккаунт
</div>

* Бесплатные аккаунты доступны на [https://www.postman.com](https://www.postman.com).

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=c8e937020db9cbeb341e57f69afbe920" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=20f172c520195fd8765db38699b08557" size="md" alt="Создание рабочего пространства" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.webp" />

<div id="create-a-collection">
  ### Создайте коллекцию
</div>

* В меню слева вверху, под пунктом "Explore", нажмите "Import":

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=0d7cf5d604f168200fd44c87c21c2a93" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=7935a8d073a66d13c22b59fbc1943724 280w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=081dd4846e5281e9825306401f9b189e 560w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=b086f4647269d3eb61be3185e5fc2131 840w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=cd90c4cc515c1b8af9fbdb22017eafae 1100w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=15239ca9ca59d503882a61eeb1917b3b 1650w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=bbd521efcbec31bbfe77ad2e7a91cdcb 2500w" />

* Откроется модальное окно:

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=f21c7d1d6a313693bfd50eb86edb85e9" size="md" alt="Поле ввода URL API" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.webp" />

* Введите адрес API: "[https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1)" и нажмите 'Enter':

* Нажмите кнопку "Import" и выберите "Postman Collection":

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=da347bbae0e723d993e1ec7942f24012" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=905bd0cbf854a0e9b0e6febe98f7696d 280w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=159c9001ccdf50fc880e67992edaa4d1 560w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=0145439294707be76f54f010809c15ae 840w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=9873c7564a21cb701205f926baace2e5 1100w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=c378e5b6fec0ce84078d53671067c39c 1650w, https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=7e0c328fa37df6d70eca4e9cecd612ac 2500w" />

<div id="interface-with-the-clickhouse-cloud-api-spec">
  ### Работа со спецификацией ClickHouse Cloud API
</div>

* Теперь "API spec for ClickHouse Cloud" будет отображаться в разделе "Коллекции" (слева на панели навигации).

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=fa3ef8614b84236050dd2f4531bec9c1" size="md" alt="Импортируйте свой API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.webp" />

* Нажмите "API spec for ClickHouse Cloud". На центральной панели выберите вкладку 'Authorization':

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=d7104587d6a337dd04a7e7ab4a15d34a" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=6581c0f5e7fe44162f0d95d8a553c320" size="md" alt="Basic Auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.webp" />

* Введите имя пользователя и пароль, полученные при настройке ключей API ClickHouse Cloud:

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=97afcc2d52737e087489fcf76a32d6b1" 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">
  #### Укажите идентификатор организации и идентификатор сервиса
</div>

* В разделе "коллекция" на средней панели нажмите вкладку "Variable" (Base URL уже был задан ранее при импорте API):
* Под `baseURL` щёлкните по пустому полю "Add new value" и подставьте идентификатор своей организации и идентификатор сервиса:

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=970afdc12491a881270e45c8f4b1ac33" size="md" alt="Идентификатор организации и идентификатор сервиса" 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 list of available organizations"
</div>

* В разделе "OpenAPI spec for ClickHouse Cloud" раскройте папку > V1 > organizations
* Нажмите "GET list of available organizations", а затем синюю кнопку "Send" справа:

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=dc538af249a056314f77dea0b106b641" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=75c0776048221c335cc3a8e9ee937f6c" size="md" alt="Статус" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.webp" />

<div id="test-get-organizational-details">
  ### Проверка "GET organizational details"
</div>

* В папке `organizationid` выберите "GET organizational details":
* В центральной панели в разделе Params требуется указать `organizationid`.

<Image img="https://mintcdn.com/private-7c7dfe99-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=ebdee2d84ca99cb63d8a432163472e25" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=6d88e7d64cbc4ab3cbdd7de899f898a4" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=4266e7bc1c49a7b2db84f24eca977d6b" 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-parallel-read-in-order-multi-part/xI74_SSNk8kNyW21/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=xI74_SSNk8kNyW21&q=85&s=7e9862e776047e8008a380d9e7234f95" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

* В ответе должен вернуться список ваших сервисов и сведения о них со "status": 200. (Если вы получаете "status" 400 без информации о сервисах, значит, конфигурация указана неверно).