> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=59508fae391eb40fb756da88e4032a9e" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=112347769f74f2563d07b0a99061cbd5" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=1a576f9f10f3ee038bcb0f5c06a50bc2" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=d854b7c9a82cf6cd49e836dd32966890 280w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=d98a75bd864a0e7a71e6d2634bff4b7a 560w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=dd6e86cadde7a4faac270b1501f2e187 840w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=e64f6320cb9a825875ce94e552f7dae1 1100w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=71f54f26d8fba7721f5990f5f46c8e1b 1650w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=d8a2a7004b43d9f63aade8d9f1e9f6d5 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=6f9e34f97280f9515da3676a5f65ea4c" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=8fe55b5ba2b222670095ab0122d408ab" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=f12850997a5c6e76056cf7ce4897e7d4 280w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=be1c7738a41de9c0b1f8fa62e4cb2e6e 560w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=ea2c1039a4e245566376d3ddf20ad60b 840w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=448f167cc43a46532059afb6cfaab45e 1100w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=12a420a9e97f1095cb15e52bf9838393 1650w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=50208f625ca3aac230da9101d978176c 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=8c0f73f0ff6a24c698ccf22e4b6514de" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=d74102fc0b5a837eb6385629a6d492a0" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=592e15688e4f26177aeb15c9015a95a6" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=348536953f0b43d0714e3890e33fc04a" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=e119d6b68387b6f95d890fdbbdcb3954" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=36cae3b48811b1def044251605a8db12" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=c558c3ed61fa7b982f2ca1396872c3f5" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=98494b844580046b28fb3597c000f39a" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=0144e4613b6b4a98b4cd397c3ad3abe8" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=ece5268a49ab8bffc287b70b835579f3" 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=da0680d69e598e90bed0e362dc83ae27" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

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