> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-home-button.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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=77d3157a1cfe42f7e9b28c981a81935e" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=4131eaed5f5a1e2ddd3adcca933bb8da" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=44fbb20ba7036e2da71fc77c626795a1" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=b06045611848e39066fefd55d978f2a5 280w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=05e721ade1be264a4301a6be381ed1c3 560w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=669c4ff5117bb760981ecee813d4a490 840w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=18a3337f054e6dee7d55ad728cbd45ca 1100w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=86c34c1032b32abc61c597ac956e9e8b 1650w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=94e62964db90315641496541a4f62cf4 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=5e16cfd929a754d87204fb811878001f" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=9d5ac92c7d0c15b4675913aebddc9fbc" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=42a2b0db5d51e1e314e0e66a3a019f47 280w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=5025d993d2303c81bdedeb1cfba17a34 560w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=153854c0e103ee8f0841167f5bcc8a1c 840w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=f30dbc5c2761b4f1c2a1dd23ac19017d 1100w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=eb24de1783e29f0e59f733450a3c1f48 1650w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=ac6c8369b7caf9cfbfe71ed6a8ac3d75 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=f086508386a377720d146bcf8b9441b2" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=e1c17b85cc2b0ee664efb8d940ab041c" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=74da95f55efb73c8aa2d251da6c2f893" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=40fb93b899c532ed89e25e60d71ded6f" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=2286880fdfd03b7098021125a6236307" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=3b32e72c51d50157eedb7de366eac8cf" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=05c4e3e08c42c46ec3d18cae5f3fe03f" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=e0f4ff172530473943c3b56d7fb4d7fb" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=7ff48499b7cc734aa26a8bfd72a2a412" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=bfef37298052fce5568ae1081ce2417f" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=7c72eb426205aced4a39c544e12f4805" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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