Saltar al contenido

Grupos de API

Introducción

La página Grupos de API dentro del API Manager permite un administrador de organización de Harmony para crear un grupo de APIs que usuarios externos puede acceder.

Para realizar acciones o realizar ediciones en la página Grupos de API, se requiere una rol con permiso de Administrador. Los usuarios con roles con acceso al ambiente Write pueden abrir la página pero no pueden ver el contenido.

Acceda a la Página de Grupos de API

Se puede acceder a la página Grupos de API desde el menú del Portal Harmony o desde otras páginas dentro del API Manager:

Encabezado de Página de Grupos API

El encabezado en la parte superior de la página Grupos de API incluye navegación dentro del API Manager, un cuadro de búsqueda y un botón para crear un nuevo grupo de API:

encabezado

  • Navegación: Utilice el menú de navegación de API Manager para navegar a otras páginas dentro de la interfaz de usuario de API Manager.

  • Buscar: Ingrese cualquier parte del nombre de un grupo de API en el cuadro de búsqueda para filtrar los grupos de API por nombre. La búsqueda no distingue entre mayúsculas y minúsculas.

  • Agregar grupo: Haga clic para crear un nuevo grupo de API.

Crear un Grupo de API

Al hacer clic en el botón Agregar grupo en el encabezado de la página, se le presenta esta interfaz de usuario:

agregar nuevo grupo

  • Nombre del grupo API: Ingrese un nombre para identificar el grupo API.

  • Ambiente: Seleccione el ambiente para incluir todas las APIs de ese ambiente en el grupo de API.

  • API: Una a la vez, seleccione una API para incluirla en el grupo de API. Al hacer clic en el nombre de una API individual, se muestra información adicional sobre la API en el panel derecho, como la versión de la API, la URL del servicio y las operaciones asignadas a la API.

  • Guardar: Haga clic para guardar el grupo de API y cerrar la configuración.

  • Cancelar: Haga clic para descartar el grupo de API y cerrar la configuración.

Grupos de API

Los grupos de API existentes se muestran a continuación y tienen estas opciones:

grupos de API

  • Ver: Haga clic en el triángulo desplegable divulgación a ver detalles adicionales sobre el grupo API.

  • Editar: Haga clic en el ícono de edición icono de edición para agregar o eliminar las APIs en el grupo de API.

  • Eliminar: Haga clic en el ícono de eliminar icono de eliminar para eliminar el grupo de API.

Ver un Grupo de API

Al visualizar un grupo de API, se le presenta esta interfaz de usuario:

ver grupos de API

  • API: El nombre de la API.

  • Versión: La versión de la API.

  • Ambiente: El ambiente de la API.

  • Ruta: El prefijo de URL, la versión de API y la raíz del servicio de URL del servicio API.

  • Copiar: Haga clic en el ícono de copiar icono de copiar para copiar la Ruta al portapapeles.