Administrador de Portales¶

Introducción¶

La página del Portal Manager le permite generar documentación de OpenAPI para las APIs personalizadas y de proxy. La documentación resultante se muestra en el Portal, donde puede interactuar con él probando las APIs. Esta página describe la interfaz de usuario de la página Administrador de portal dentro del API Manager.

Limitaciones¶

La página del Portal Manager tiene estas limitaciones:

• No se admite la generación de documentación OpenAPI para OData Services.
• Solo se puede crear una única página de Portal para cada ambiente en una organización de Harmony.

Acceso a la Página del Administrador del Portal¶

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

• Desde el Inicio o Descargas o desde Cloud Studio, Vinyl, Marketplace, Management Console, EDI, o Citizen Integrator, use el menú de Harmony Portal en la parte superior izquierda para ir a API Manager > Portal Manager:

  

• Desde Mis APIs, Registros de la API, Análisis, Perfiles de seguridad, Grupos de IPs Confiables, o Grupos de API, utilice el menú de navegación del API Manager para seleccionar Administrador del portal:

  

Encabezado de la Página del Administrador del Portal¶

La página del Administrador del portal también se denomina Administrar el portal del desarrollador, ya que es la página donde administra lo que aparece en el Portal (también llamada Gestionar portal de desarrolladores).

Estas opciones aparecen en la parte superior de la página del Administrador del portal:

• Navegación: Utilice el menú de navegación del API Manager para navegar entre las páginas del API Manager, incluidas Mis APIs, Portal, Registros de la API, Análisis y Perfiles de seguridad.

• Ambiente: Haga clic en el nombre del ambiente para seleccionar el ambiente en el que se generará la documentación de OpenAPI y luego se mostrará en la página del Portal de una organización:

  

  Para actualizar la lista de ambiente, haga clic en el icono de actualización .

  Nota

  Solo se puede crear una única página de Portal para cada ambiente en una organización de Harmony.

• Ver documentación de la API: Haga clic para ir al Portal, donde se representa la documentación de la API interactiva generada.

• Regenerar documentos y publicar: Haga clic para sobrescribir y publicar la documentación de OpenAPI 2.0 en la página del Portal para todas las APIs personalizadas y de proxy en el ambiente seleccionado. Los Servicios OData están excluidos. Si ha publicado una nueva proxy de API y desea volver a generar automáticamente la documentación para incluir nuevas APIs, debe usar esta opción.

  Advertencia

  El uso de esta opción sobrescribe la documentación API existente, incluidas las personalizaciones. Antes de usar esta opción, se recomienda hacer una copia manual de la documentación de la API existente copiándola en un editor de texto externo. Después de volver a generar la documentación, vuelva a aplicar manualmente las personalizaciones pegándolas en el editor de documentación de la API, según corresponda.

• Guardar y publicar: Haga clic para guardar y publicar la documentación de la API en la página del Portal. Si ha aplicado personalizaciones a la documentación de la API generada automáticamente, debe usar esta opción para publicar la documentación en la página del Portal.

Personalizar la Página del Portal¶

El portal la página se puede personalizar con una imagen, como el logotipo de una empresa, o con ediciones en la documentación API generada automáticamente.

Agregar una Imagen¶

Para agregar una imagen, haga clic en Examinar archivos locales y seleccione una imagen que cumpla con los requisitos enumerados:

La imagen cargada se publica automáticamente en la página del Portal sin necesidad de hacer clic en Regenerar documentos y publicar o Guardar y publicar.

Para eliminar una imagen después de cargarla, haga clic en Eliminar imagen:

Edite la Documentación de la API¶

Documentación interactiva siguiendo la OpenAPI Specification 2.0 se genera automáticamente para todas las APIs personalizadas y de proxy en el ambiente seleccionado.

Las definiciones de OpenAPI se muestran en el editor en el lado izquierdo de la página y se representan como interfaz de usuario de Swagger documentación en el lado derecho de la página:

Puede editar las definiciones de OpenAPI directamente dentro del editor en el lado izquierdo de la página. Estos son ejemplos de personalizaciones para la documentación de la API:

• Complete los metadatos sobre la API, incluidos Campos fijos como title, description, termsOfService, contact, license, y version.
• Sobrescribir manualmente la documentación usando la Especificación 3.0 de OpenAPI.

Después de editar la documentación de la API, haga clic en Guardar y publicar para guardar y publicar la documentación en el Portal página.

Para regenerar y publicar documentación después de publicar una nueva API, use el botón Regenerar documentos y publicar.

APIs de Prueba¶

La documentación de API generada a partir de las definiciones de OpenAPI que se muestran en el editor en el lado izquierdo de la página, se presenta como una interfaz de usuario de Swagger documentación en el lado derecho de la página como se muestra arriba. La documentación de la API renderizada también se muestra en el Portal página. Puede usar la documentación interactiva para probar las llamadas proxy de API para validar que funcionan correctamente.

La documentación de los elementos comunes de la interfaz de usuario de Swagger se proporciona a continuación. Para obtener documentación sobre todos los elementos posibles, consulte OpenAPI Specification 2.0 o Especificación OpenAPI 3.0.

Esquemas¶

Utilice el menú desplegable para seleccionar entre los esquemas disponibles admitidos por las definiciones de OpenAPI:

Autorización¶

Si alguna de las APIs dentro del ambiente seleccionado requiere una autorización establecida por un perfil de seguridad asignado, se muestra un botón Autorizar:

Al hacer clic en Autorizar, un cuadro de diálogo muestra las autorizaciones disponibles. Complete la entrada según sea necesario para probar las APIs con los métodos de autorización proporcionados:

Extremos¶

Cada extremo de la API se enumera con su método:

El icono de autorización indica si el extremo de la API requiere autorización:

• : No se requiere autorización.
• : Se requiere autorización.

Haga clic en la fila del extremo para ampliar la información sobre sus parámetros y respuestas:

Pruébalo¶

Haga clic en el botón Pruébelo para expandir un área configurable:

Configure la solicitud que se enviará al extremo y luego haga clic en Ejecutar:

La solicitud enviada se envía al extremo y se devuelve la respuesta: