Использование API создания площадки Cato с Postman

Эта статья объясняет, как использовать клиент Postman API и выполнять API Cato для предоставления площадок в приложении управления Cato.

Обзор конфигурации Postman

Это краткий обзор конфигурации Postman для выполнения API конфигурации Cato для предоставления и обновления площадок.

Сгенерируйте ключ API из приложения управления Cato.
Скачайте и импортируйте коллекцию и окружение Postman.
Настройте окружение.
Запустите API и предоставьте площадки в аккаунте.

Генерация ключа API из приложения управления Cato

Ключ API — это код, который клиент API использует для аутентификации в вашем аккаунте Cato. Вы можете использовать экран управления API в приложении управления Cato для генерации ключа API с разрешением на редактирование.

Чтобы сгенерировать ключ API для API создания Cato:

В навигационном меню нажмите Ресурсы > Ключи API.
На вкладке Ключи API нажмите Новый. Откроется панель Создать ключ API.
Введите Имя ключа.
Установите Разрешение API на Редактирование.
Мы рекомендуем задать дату, когда ключ API Истекает.
Нажмите Применить. Ключ API добавлен, и отображается всплывающее окно с новым ключом API.
Нажмите (Копировать) и скопируйте ключ API, который генерируется приложением управления Cato, и сохраните его в защищенном месте.

После закрытия этого окна вы не сможете получить доступ к значению ключа API.
Нажмите ОК, чтобы закрыть всплывающее окно.

Добавление коллекции и окружения API Cato в Postman

Мы создали пользовательскую коллекцию и окружение Postman, чтобы помочь вам начать предоставление площадок с помощью API создания Cato. Эти пользовательские файлы доступны в репозитории Cato.

_cato_env_template_.postman_environment.json
Файлы Mutation API для конфигурации API (такие как Cato Site Mutation API v1.postman_collection.json)

Окружение Postman содержит переменные (URL API, ID аккаунта CMA и т.д.), а коллекция Postman содержит примеры вызовов GraphQL Mutation API. Чтобы импортировать их, нажмите ‘Импортировать’, перетащите файл в окно и нажмите «импортировать»:

Чтобы добавить коллекцию и окружение для API Cato в Postman:

Скачайте пользовательскую коллекцию и окружения из этой статьи базы знаний на ваше устройство.
В Postman выберите Файл > Импорт. Откроется всплывающее окно Импорт.
Нажмите Загрузить файлы, затем выберите файлы, которые вы скачали на шаге 1.
Нажмите Импортировать.

Теперь в Postman отображается пользовательское окружение в Окружениях:

Теперь в Postman отображается пользовательская коллекция в Коллекциях:

Конфигурация окружения Postman

Мы рекомендуем использовать отдельное окружение Postman для каждого арендатора Cato, где вы храните ID аккаунта CMA и ключ API.

Чтобы создать новое окружение Postman:

На вкладке Окружение щелкните правой кнопкой мыши по шаблону _cat_env_template_ и выберите Дублировать.
Щелкните правой кнопкой мыши копию окружения, выберите Переименовать, затем переименуйте окружение в имя вашего арендатора Cato.
Скопируйте Ключ API и ID аккаунта CMA, и вставьте их в Текущее значение соответствующих полей в окружении и нажмите Сохранить.

Вы можете получить ID аккаунта CMA прямо из URL:

Выполнение вызова API Cato для предоставления площадок

После того как вы определите ключ API и ID аккаунта CMA для Postman

Чтобы выполнить вызов API и предоставить площадки:

На вкладке Коллекции.
В правом верхнем углу выберите окружение, которое вы создали на предыдущем шаге.
На вкладке Коллекции раскройте Cato Mutation API v1 > addSocketSite > _query и выберите query_stateCode.
Нажмите Отправить, чтобы выполнить вызов API. Ожидаемый результат 200 OK и некоторые данные.