> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=a17ff568428176d30a9c8aa80133b55d" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=243d343725a3aa49c70181399c336cdd" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=42d77d7c32716e4e481bbacfb42b565d" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=e1e1159867baabde04b1a80549eaf3a1 280w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=d8e1bb3c4c741c42676a435765f6b7a3 560w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=bbf7ea77ab6fd64a112c8cfb33658165 840w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=edfbddeeb2c5245520df1e9f8e46d261 1100w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f642661811641883587cd3869581c067 1650w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=47fde21dd9031cc1738046a584204ceb 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=7a972d25323b766b3a1cd685e72d17ce" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b2f69bc914e1c62a55189d09302daac6" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=c51dbbcddbd62046357f90fbbe8b4e12 280w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=ab5c03ed0049c9afd4d25269129f358b 560w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=9fd7596109a0702b484291195e46b232 840w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b80c7029ef892192b7baaeda77d5a528 1100w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f90bbd7e34739b175e3fee4c6f34df6e 1650w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f27a3d978a3834f8ad8c24b2e5bf5978 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b6dac29e785b0ea50924d23b6b7d7769" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=d0329f48484f8e40be650a57b948d128" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=c113ffb2cf0e4f1a2ff0a29265f0805b" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b6f43307a0d912bc8051d2f2a796e7f6" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=ce74d088c994be1bae8b29d1bbacce3a" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=0743c41540a2d80a028b63d566894a7e" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=08627f71b293e5ebc3fa2d49f5b5bd91" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=7998a141ad4986a9863ad7b8f85599de" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=774209dae04db0793b5a3c98da8f2f48" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=622d3f0f5b3a7fedb95fa2448faa691c" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=78bbf324adf043fa74ce951564edb1f9" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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