Эта статья объясняет, как использовать GraphQL Playground для выполнения некоторых примерных запросов и тестирования подключения к конечной точке API Cato.
GraphQL Playground позволяет выполнять запросы API, которые отправляются непосредственно на сервер API Cato. Стороннее программное обеспечение для выполнения запросов API, такое как Altair или Postman, предоставляет мощные функции для выполнения вызовов API. Однако, если возникают проблемы с подключением при выполнении запросов API, вы можете использовать Playground, чтобы помочь определить причину проблемы.
Для выполнения запроса API Cato из GraphQL Playground у вас должен быть ключ API для вашей учетной записи (Ресурсы > Ключи API). Для получения дополнительной информации о ключах API, смотрите Создание ключей API для Cato API.
Вам необходимо ввести ID Приложения Управления Cato (CMA) для вашей учетной записи в примерных запросах. Вы можете найти ID CMA на странице Информация об учетной записи.
URL для конечной точки API специфичен для местоположения, где размещается экземпляр Приложения Управления Cato (CMA). Может существовать значение <prefix>, которое добавляется к URL вашей учетной записи CMA и к конечной точке API.
-
Если префикса нет (
cc.catonetworks.com), используйте следующий URL:https://api.catonetworks.com/api/v1/graphql2 -
Если префикс есть (например,
cc.us1.catonetworks.com), используйте следующий URL:https://api.us1.catonetworks.com/api/v1/graphql2
Вы можете выполнить примерный запрос API для тестирования подключения к серверу API Cato. Если аргумент accountID и ключ API настроены правильно, примерный запрос API возвращает данные учетной записи и показывает результаты в GraphQL Playground. Если запрос не возвращает результаты для вашей учетной записи, возможно, присутствует проблема с подключением к серверу API или сервер не работает. Следующие примеры запросов API помогают протестировать подключение к серверу API Cato:
Используйте интернет-браузер для открытия GraphQL Playground для API Cato. Настройте HTTP заголовок для Playground с вашим ключом API. Вставьте примерный запрос в левую панель и введите ID вашей учетной записи. Затем вы можете выполнить запрос и увидеть результаты в Playground.
-
Скачайте один из примеров запросов API из этой статьи и откройте файл в текстовом редакторе, таком как Notepad.
-
Через интернет-браузер перейдите в GraphQL Playground для API Cato.
-
В нижней части левой панели нажмите HTTP HEADERS.
-
Введите ваш ключ API в следующем формате:
{ "x-api-key" :"<api key>" }.Следующий скриншот показывает HTTP заголовок, настроенный с API ключомAaBbCcDdEeFf0123456789ABCDEF1234:
-
Скопируйте и вставьте один из примерных запросов в левую панель Playground.
-
В верхней части запроса, в аргументе
accountID, введите ID вашей учетной записи.Следующий скриншот показывает аргумент
accountID, настроенный со значением 2626: -
Нажмите на кнопку воспроизведения.
-
Правая панель показывает результаты запроса API. Следующий скриншот показывает результаты для примерного запроса метрикиАккаунта для ID учетной записи 2626:
0 комментариев
Войдите в службу, чтобы оставить комментарий.