Este artículo explica cómo usar el GraphQL Playground para ejecutar consultas de muestra y probar la conectividad con el endpoint de la API de Cato Networks.
El GraphQL Playground te permite ejecutar consultas API que se envían directamente al servidor API de Cato. Software de consulta de API de terceros como Altair o Postman, proporcionan una funcionalidad poderosa para ejecutar llamadas API. Sin embargo, si hay un problema de conectividad con las consultas API, puedes usar el Playground para ayudar a identificar la causa del problema.
Para ejecutar una consulta API de Cato desde el GraphQL Playground, debes tener la clave API de tu cuenta (Recursos > Claves API). Para más información sobre las claves API, consulta Generar claves API para la API de Cato.
Necesitas ingresar el ID de la Aplicación de Gestión de Cato (CMA) para tu cuenta en las consultas de muestra. Puedes encontrar el ID de la CMA en la página Información de la Cuenta.
La URL para el punto de conexión de la API es específica de la ubicación donde se aloja la instancia de la Aplicación de Gestión de Cato (CMA). Puede haber un valor <prefix> que se agrega a la URL de tu cuenta CMA y al punto de conexión de la API.
-
Si no hay prefijo (
cc.catonetworks.com), entonces utiliza la siguiente URL:https://api.catonetworks.com/api/v1/graphql2 -
Si hay un prefijo (como
cc.us1.catonetworks.com), entonces usarías la siguiente URL:https://api.us1.catonetworks.com/api/v1/graphql2
Puedes ejecutar una consulta API de muestra para probar la conectividad al servidor API de Cato. Cuando el argumento accountID y la clave API están configurados correctamente, la consulta API de muestra devuelve los datos de la cuenta y muestra los resultados en el GraphQL Playground. Si la consulta no devuelve resultados para tu cuenta, entonces puede haber un problema de conectividad al servidor de API o el servidor puede estar caído. Las siguientes consultas API de muestra pueden ayudarte a probar la conectividad al servidor API de Cato:
Usa un navegador de Internet para abrir el GraphQL Playground para la API de Cato. Configura el encabezado HTTP para el Playground con tu clave API. Pega la consulta de muestra en el panel izquierdo e ingresa tu ID de cuenta. Entonces puedes ejecutar la consulta y ver los resultados en el Playground.
-
Descarga una de las consultas API de muestra de este artículo y abre el archivo en un editor de texto como el Bloc de notas.
-
Desde un navegador de Internet, ve al GraphQL Playground para la API de Cato.
-
En la parte inferior del panel izquierdo, haz clic en HTTP HEADERS.
-
Ingresa tu clave API en este formato:
{ "x-api-key" :"<clave api>" }.La siguiente captura de pantalla muestra el encabezado HTTP configurado con la clave APIAaBbCcDdEeFf0123456789ABCDEF1234:
-
Copia y pega una de las consultas de muestra en el panel izquierdo del Playground.
-
En la parte superior de la consulta, en el argumento
accountIDingresa tu ID de cuenta.La siguiente captura de pantalla muestra el argumento
accountIDconfigurado con el valor 2626: -
Haz clic en el botón de reproducción.
-
El panel derecho muestra los resultados de la consulta API. La siguiente captura de pantalla muestra los resultados para la consulta de ejemplo accountMetrics para el ID de cuenta 2626:
0 comentarios
Inicie sesión para dejar un comentario.