Перейти к основному содержанию
Перейти к основному содержанию

Программный доступ к API с помощью Postman

Это руководство поможет вам протестировать ClickHouse Cloud API с помощью Postman. Приложение Postman доступно как в веб-интерфейсе, так и в виде десктопного приложения.

Создайте учетную запись​

Сайт Postman

Создайте рабочее пространство​

  • Задайте имя рабочему пространству и уровень видимости.
Create workspace

Создание коллекции​

  • В меню слева вверху под "Explore" нажмите "Import":
Explore > Import
  • Появится модальное окно:
API URL entry

  • Введите адрес API: "https://api.clickhouse.cloud/v1" и нажмите клавишу Enter:

  • Выберите "Postman Collection", нажав кнопку "Import":

Collection > Import

Взаимодействие со спецификацией API ClickHouse Cloud​

  • «API spec for ClickHouse Cloud» теперь отобразится в разделе «Collections» (левая панель навигации).
Import your API
  • Нажмите «API spec for ClickHouse Cloud». В средней панели выберите вкладку Authorization:
Import complete

Настройте авторизацию​

  • В выпадающем списке выберите «Basic Auth»:
Basic auth
  • Введите имя пользователя (Username) и пароль (Password), полученные при создании ключей API в ClickHouse Cloud:
credentials

Включите переменные​

  • Переменные позволяют сохранять и повторно использовать значения в Postman, что упрощает тестирование API.

Установите идентификатор организации и Service ID​

  • Внутри "Collection" перейдите на вкладку "Variable" в средней панели (значение Base URL уже было установлено при предыдущем импорте API):
  • Под baseURL в открытом поле "Add new value" подставьте свой идентификатор организации и Service ID:
Organization ID and Service ID

Проверка возможностей API ClickHouse Cloud​

Тест «GET list of available organizations»​

  • В разделе «OpenAPI spec for ClickHouse Cloud» разверните папку > V1 > organizations
  • Нажмите «GET list of available organizations» и затем синюю кнопку «Send» справа:
Test retrieval of organizations
  • В ответе должны быть указаны сведения о вашей организации со «status»: 200. (Если вы получили «status» 400 без информации об организации, ваша конфигурация настроена неверно).
Status

Тестирование "GET organizational details"​

  • В папке organizationid перейдите к "GET organizational details":
  • В средней панели в меню Params требуется указать organizationid.
Тестирование получения сведений об организации
  • Измените это значение на orgid в фигурных скобках {{orgid}} (поскольку это значение было задано ранее, в меню появится соответствующий вариант):
Отправка тестового запроса
  • После нажатия кнопки "Save" нажмите синюю кнопку "Send" в правом верхнем углу экрана.
Возвращаемое значение
  • Возвращённый результат должен содержать сведения о вашей организации со "status": 200. (Если вы получаете "status" 400 без информации об организации, ваша конфигурация настроена неверно).

Тестирование метода "GET service details"​

  • Нажмите "GET service details".
  • Измените значения organizationid и serviceid на {{orgid}} и {{serviceid}} соответственно.
  • Нажмите "Save", затем синюю кнопку "Send" справа.
List of services
  • В возвращённых результатах должен быть список ваших сервисов и их деталей со значением "status": 200. (Если вы получаете "status": 400 без информации о сервисах, ваша конфигурация настроена некорректно).