Este artículo explica cómo usar el cliente de API de Postman y ejecutar las APIs de Cato para aprovisionar sitios en la Aplicación de Gestión de Cato.
Esta es una descripción general de alto nivel sobre cómo configurar Postman para ejecutar la API de configuración de Cato para aprovisionar y actualizar sitios.
-
Genera la clave API desde la Aplicación de Gestión de Cato.
-
Descarga e importa la Colección y el Entorno de Postman.
-
Configura el Entorno.
-
Ejecuta la API y aprovisiona sitios en la cuenta.
La clave API es un código que el cliente API utiliza para autenticarse con tu cuenta de Cato. Puedes usar la pantalla de Gestión de API en la Aplicación de Gestión de Cato para generar una clave API con permisos de Edición.
Para generar una clave API para la API de Creación de Cato:
-
En el menú de navegación, haz clic en Recursos > Claves API.
-
En la pestaña Claves API, haz clic en Nuevo. Se abre el panel Crear Clave API.
-
Introduzca el Nombre de la Clave.
-
Configure el Permiso API en Editar.
-
Recomendamos establecer una fecha en la que la clave API Expire en.
-
Haz clic en Aplicar. La clave API se agrega y se muestra una ventana emergente con la nueva clave API.
-
Haz clic en
(Copiar) y copia la Clave API que se genera por la Aplicación de Gestión de Cato y guárdala en un lugar seguro.
Una vez que cierres esta ventana, no podrás acceder al valor de la clave API.
-
Haz clic en OK para cerrar la ventana emergente.
Creamos una Colección y un Entorno personalizados de Postman para ayudarte a comenzar a aprovisionar sitios con la API de Creación de Cato. Estos archivos personalizados están disponibles en el repositorio Cato.
- _cato_env_template_.postman_environment.json
- Archivos de API de Mutación para la API de configuración (como Cato Site Mutation API v1.postman_collection.json)
El Entorno de Postman contiene variables (URL de la API, ID de la cuenta CMA, etc...) y la Colección de Postman contiene ejemplos de llamadas de API GraphQL de Mutación. Para importarlos, haz clic en "Importar", suelta el archivo en la ventana y haz clic en importar:
Para añadir la Colección y el Entorno de la API de Cato a Postman:
-
Descarga la Colección y los Entornos personalizados de este artículo de la base de conocimientos en tu dispositivo.
-
Desde Postman, selecciona Archivo > Importar. Se abre la ventana emergente Importar.
-
Haz clic en Subir Archivos, y luego selecciona los archivos que descargaste en el paso 1.
-
Haz clic en Importar.
El Entorno personalizado ahora se muestra en Entornos de Postman:
La Colección personalizada ahora se muestra en Colecciones de Postman:
Recomendamos que uses un Entorno separado de Postman para cada Inquilino de Cato donde guardes el ID de la Cuenta CMA y la Clave API.
Para crear un nuevo entorno de Postman:
-
Desde la pestaña Entorno, haz clic derecho en el template _cat_env_template_ y selecciona Duplicar.
-
Haz clic derecho sobre la copia del Entorno, selecciona Renombrar, luego renombra el Entorno con el nombre de tu inquilino de Cato.
-
Copia la Clave API y el ID de la Cuenta CMA, y pégalos en el Valor Actual de los campos relevantes en el Entorno y haz clic en Guardar.
Puedes recuperar el ID de la cuenta CMA directamente desde la URL:
Después de definir la Clave API y el ID de la cuenta CMA para Postman
Para ejecutar la llamada API y aprovisionar sitios:
-
En la pestaña Colecciones.
-
En la esquina superior derecha, selecciona el Entorno que creaste en el paso anterior.
-
Desde la pestaña Colecciones, expande Cato Mutation API v1 > addSocketSite > _query y selecciona query_stateCode.
-
Haz clic en Enviar para ejecutar la llamada API. El resultado esperado es 200 OK y algunos datos.
0 comentarios
Inicie sesión para dejar un comentario.