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

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

Этот гид поможет вам протестировать API ClickHouse Cloud с использованием Postman. Приложение Postman доступно для использования в веб-браузере или может быть загружено на рабочий стол.

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

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

  • Назовите ваше рабочее пространство и установите уровень видимости.

Создайте коллекцию​

  • В левом верхнем меню ниже "Explore" нажмите "Import":
  • Появится модальное окно:
  • Выберите "Postman Collection", нажав на кнопку "Import":

Интерфейс с API ClickHouse Cloud​

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

Установка авторизации​

  • Выберите из выпадающего меню "Basic Auth":
  • Введите имя пользователя и пароль, которые вы получили при настройке ключей API ClickHouse Cloud:

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

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

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

  • В "Collection" нажмите на вкладку "Variable" в средней панели (Базовый URL уже был установлен ранее при импорте API):
  • Под baseURL нажмите открытое поле "Add new value" и замените ваш идентификатор организации и идентификатор сервиса:

Тестирование функциональности API ClickHouse Cloud​

Тест "GET список доступных организаций"​

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

Тест "GET данные организации"​

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

Тест "GET данные сервиса"​

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