> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-vortex-format.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"}) => {
  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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=8f3f7cda47c0f3ac898de4e2fd5d9248" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=062e8c49f4bd698c7ae558c17db3f6e9" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=52dd7913c382f5695f82b96ddd06db54" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=95cad0f9ebefd3a779c846787b33a680 280w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=b36f360b8e3813cce3e4387f881ff221 560w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=2ac8e3e37c8c9f7ab507cd345e0b488d 840w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=210a32cb766037792e07d356f180a684 1100w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=04b240c713b08625e3d334df37a61775 1650w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=4ae5ee8a7a8898a961a9d88482c40c76 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=e72a652da17e4254e0d16844d40519f0" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=47f9f21353bc481924d8c7ef150b510c" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=6d23976c84a141270b6b585acd7bcdba 280w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=490207378dbc4ca7c05a9aeade0b8187 560w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=18c5d07a8a32e953aadec2c263c4ffb9 840w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=a1fb6d7da8ea6b3600a9aa727030c0fa 1100w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=075801c79cb4beb287594df00e36f7f1 1650w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=d9ea8b0fe14b1eaa42fa3fbbcceb04f1 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=65ec25c0cf1e2a2ebe433ec6b24a7286" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=0b75da2501a9a7eba9544bbb0c49eae5" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=86c17d0b773deebe08646fbb80e77a13" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=91beb8e82dca2bad3d0b89516ca1b69a" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=1371acd604d4b7ebbf14de39dad2d722" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=70787f1f11fb6874d6e9bd77b00ee56c" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=c32fea48083184a371b5b76868c50905" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=f2bc64f9ab7fb1c6dec11eb2f6bff131" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=f55000c865aefd2c971b7827e5f87b75" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=cff855b3498fe90ecd392a143b4069d6" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=e94dfd37404478034257b2065fba06ae" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

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