> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/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"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=11db32bb6994568e72300e06adff39bd" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=68bfd0e5f8f91265bf13b7fdcf38b7b1" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=2346a66ffbe88d4867cdd2995514419a" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=0bdabceff91fe431807f33c1cc7b3e80 280w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=5467245be30a7e239003ad4a33d06a45 560w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=48df6f772537bf53c3620d842f091778 840w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=535812295b6d5e298a14b1f2ea9e2ace 1100w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=07a6efb1d317f12702dec15639de5b75 1650w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=568641b1fa3cdb0bdc98fc5d71a0b58b 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=e9e8d06467f18c959ebcd7562e4f6369" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=5f8ba05858e5228475b2fcfe771db986" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=637d3e0017f8a82d2d007358cbe778cc 280w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=6854c47483aa927d9b6004efb8676931 560w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=166cb256b65f35c3d986b52d37d1469a 840w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=05006c9d3aa6a6ff0d090393a3a6775e 1100w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=a59ca93ffa6ab0eb82686003e7eb0038 1650w, https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=f33678e07b73028e28de7359a57c148d 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=a81af7bb216d3431c8f8157f8e622d89" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=776e266239116f6bba829eecf569f4e9" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=714ee1b85dd8fe00e4a4e3b2bf380dcf" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=dbf050fa931774f8dafb41ecc790e247" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=e9aab8ff60612798682926a1879c1752" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=587dadb7a2883f7c8e9534fe43ce5258" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=25f51dbcabbff7e1951bdb5bfa439998" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=9169fdf8b791b1aff626d0ee44aa937e" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=99cb8ffb74f6c4d1c10fd25fe2a291eb" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=a011b856fec4469968e51440dea2e18f" 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/REHSqgCLT_igIuJP/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=a009f261281a6ba1aaf564bc3fbbaa84" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

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