> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4.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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8dec2b8e732c3532bd706b749cb3ddbe" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8484a44c3a859c2176253eafe4916352" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=6d4aed425d88aeb47fc8d4894863059a" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=602c6d10ea86d56aea686e721c17fc4e 280w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=eeffd780f3cc6b3eb09140e7e0c7ddec 560w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=52edc70a3e65fb246703dd75d232c788 840w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=071f8ca68d7a09c4ac3fd61eef5bd032 1100w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=ecc2e84bae99f8eb59bd13b9e09593ac 1650w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=26fca1607f60af3ebc3f1fd7c3cbd883 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8785f5772f2ff830355d737e5446f281" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8924a98ef43b89e2e80da2d48af5b2d6" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=60a923c818e14533915ba570ff51dc83 280w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=1f379bf19421ef4862029ae8c1e180f9 560w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=272ae8b84cd4c88ebff4f8d2a54fea29 840w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=e372d4731887d7d4103a69cc9c950d56 1100w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=1b62929be42a4446b8f5b272be518c82 1650w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=4ed0853d18ab7f0f17cadaefd7d9d849 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=48bb0f7f5fd4e21064927373e9e3da85" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=27c04859b178b085ce1619cf260ef9e9" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=3c42e489c506c27faf88ede27843e71d" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=fed6667e2d0ff7e44ccf057afdb744b6" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=87bbac8941b2b5ed35af2227e1e886fc" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=b4755500eccddc9665f0ba21b8bb8fe0" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=e5af7e52ccfaceb93f4e6d92057f9047" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=823a77e43e32de30c966862207b1835d" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=2382d6d9a023ef1c42333029fa3b0471" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=32f564164d26e68e4f7f1db8050fe419" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=071cd7570925074fe54d8dd07a521a72" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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