Saltar al contenido

Grupos API

Introducción

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

Para realizar acciones o realizar modificaciones en la página Grupos de API, se requiere un rol con permiso Admin. 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 el menú de navegación del API Manager:

  • Utilice el menú del portal Harmony para seleccionar API Manager > Grupos de API:

    menú API Manager Grupos de API

  • Al acceder a una página de API Manager, utilice su menú de navegación para seleccionar Grupos de API:

    grupos de API del menú

Encabezado de la Página de Grupos de 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 del API Manager para navegar a otras páginas dentro del API Manager.

  • Buscar: Ingrese cualquier parte del nombre de un grupo de API en el cuadro de búsqueda para filtrar 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: De a una, seleccione una API para incluirla en el grupo de API. Al hacer clic en el nombre de una API individual, se revela 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 de la siguiente manera y tienen estas opciones:

Grupos API

  • Ver: Haga clic para ver detalles adicionales sobre el grupo API.

  • Editar: Haga clic para agregar o eliminar las APIs en el grupo API.

  • Eliminar: Haga clic 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.

  • Medio 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 de API.

  • Copiar: Haga clic para copiar la Ruta a su portapapeles.