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

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

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

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

Сайт Postman

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

  • Укажите имя рабочего пространства и установите уровень видимости.
Создание рабочего пространства

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

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

Работа со спецификацией ClickHouse Cloud API​

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

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

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

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

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

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

  • В коллекции нажмите вкладку «Variables» в средней панели (Base URL был задан при предыдущем импорте API).
  • Под baseURL нажмите на поле «Add new value» и подставьте свои идентификатор организации и идентификатор сервиса:
Идентификатор организации и идентификатор сервиса

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

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

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

Тест «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» справа.
Список сервисов
  • В возвращённом результате должен быть список ваших сервисов и сведения о них со значением "status": 200. (Если вы получаете "status" 400 без информации о сервисах, конфигурация указана неверно).