> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-c8329da0.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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=65d256810e670208add0334718b2eade" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=446caace67dccacb4d28b28e516d418d" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=004a2241b310b1ec8fa9722844949305" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=6ef56d6da15b1d3da7d219fe642a27f2 280w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=c40832cbbf445839ab1c9e584ac805ca 560w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=b8193a35bc84753e9f7220ba0e842905 840w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=4755e1bf325457625aa3be6fd1f09df2 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=299dd63e76da7e1dc8e2b3f8194d4ee8 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=63e44a478821e436e583620728c3d0c7 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=0bafe43b4e9d219f8fb615668b117495" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=9dc63d6d676d83f1c1137f5f8dbf7c21" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=897e27bbaa7f4e4ba4a42ee807a5d3f3 280w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=627d57d47e4e5aa4f2c08b00c1bc0577 560w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=d1b20e7204e21134a3d3604c61588498 840w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=428ef7604312c40554dcce14a7980f6a 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=6f98637ef222eb53466e5cc343b0f6b7 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=425e628b214ef48995804e431fd01ed9 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=1147b1757b75c08e52e6248a48b94efd" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=266b15b57b7799d1387f4db90322890b" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=0131d169045256ca4e9bbab96de833fb" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=139a0032880a770a7f39903c3af784ed" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=56a9bc674828b6d7731dfb450744a5e8" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=fd89d9ae629cd14ea78b68b919f0dd65" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=58e1885423c6f781bbdf85fe2272a5f9" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=8a236769bc9f1a30fafc8b1463bb4bff" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=5c14fbfecae5fc900026be98f6bee10f" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=064ff0dc0b16529dc64aca5bff2c6c89" 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-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=d784c5cd4dbc5555b06e981dc47774b6" size="md" alt="Список сервисов" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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