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

Программный доступ к 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» (левая панель навигации).
Импортируйте API
  • Нажмите «API spec for ClickHouse Cloud». На средней панели выберите вкладку «Authorization»:
Импорт завершён

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

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

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

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

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

  • Внутри «Collection» нажмите вкладку «Variable» в средней панели (Base URL был задан при предыдущем импорте API):
  • Под baseURL нажмите на поле «Add new value» и подставьте свой идентификатор организации и идентификатор сервиса:
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" справа:
Тест получения списка организаций
  • В полученных результатах должны быть указаны сведения о вашей организации со "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» справа.
List of services
  • В ответе должен вернуться список ваших сервисов и их параметров со статусом 200. (Если вы получаете статус 400 без информации о сервисах, ваша конфигурация настроена некорректно).