> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-76fe83d1.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}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

Это руководство поможет вам протестировать 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-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=86636e26bfee0b8e53432f0e2649def6" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=a65586fd4823f45b77afb4d18e5900f0" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=9951f8a9c21e50ed2cd1c66a98e282a5" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=3e07e24a7edbf5cfef7f7b0a0f881751 280w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=ecbcfa34a4f5ac6d1d8a9df3c89ce4a5 560w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=ffe735cd88dfcad73377a83855343001 840w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=11d452e9388c89a5ece0ce55effac62f 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=4e22193e0ba95e466b42436a1f86d8d3 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=01b9fd2223e4bcc1a7c2ddf0a7bc614d 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=91ec5fdf3b0ad14e16f96056baba7ff1" size="md" alt="Поле ввода URL API" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=abfbd042b09d0adf27fd81f32cded846" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=068d853b4e54932ce6e3e2b5ed1aea96 280w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=a3f56cf13dc4d66251d75a64fa1783e7 560w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=f018982e1ec2d721361ce16d3a0beccd 840w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=8fb1fb3a7aa320560bd76eae0cc474b7 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=b158a6fc6bf0d56e12a81fb70b35e916 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=8bacbfac467d88d05a43df4ed9a55846 2500w" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=e50a1d5726a6982a48c902233e342af3" size="md" alt="Импортируйте свой API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=915bedf6264ba333e6538da8fec3dd66" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=a12fa0a1da20e52e5f5e11fa137847b7" size="md" alt="Basic Auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=3b66fbe709a6cf2df699d4022920bcc8" 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">
  #### Укажите идентификатор организации и идентификатор сервиса
</div>

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=96c8b74095f6e3bdde12f424cf107252" size="md" alt="Идентификатор организации и идентификатор сервиса" 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 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-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=aadb0a2ed478506113df2e304725425d" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=13b946f7eeb8c259a8360027cf99fb03" size="md" alt="Статус" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=1d604cb73e766be081aecae1f802bdf0" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=98cca3a884fbcfd5d5b8e90c260084f2" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=583214e339150f9997ec0bb1fa69f751" 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-76fe83d1/lAS9qqr8rSE62gHl/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=lAS9qqr8rSE62gHl&q=85&s=65b5d860b68548847259965d896d8b23" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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