Portal¶

Introducción¶

La página Portal se administra desde el Administrador del portal y le permite acceder y utilizar la documentación interactiva generada de OpenAPI 2.0 para probar las APIs personalizadas y proxy. Esta página describe la interfaz de usuario de la página Portal dentro de API Manager.

Se puede acceder a la página Portal a través de la aplicación API Manager o mediante una invitación de un administrador de la organización Harmony, o mediante un enlace directo para aquellos con suficientes permisos de organización y acceso al ambiente.

Acceder a la Página del Portal¶

Antes de poder acceder a la página Portal, se deben cumplir estos criterios:

• Para cada API cuya documentación sea accesible desde la página Portal, se debe seleccionar en la configuración de API una rol de organización a la que se le haya otorgado un mínimo de acceso de lectura en un ambiente. Consulte estos recursos:

  • Paso 3: Asignar roles de usuario y perfiles de seguridad en Configuración de API Personalizada

  • Paso 3: Asignar roles de usuario y perfiles de seguridad en Configuración del Servicio OData

• La documentación API debe haber sido generada y publicada previamente a través del Portal Manager página.

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

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

  

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

  

Además del acceso a través de la aplicación API Manager, se puede acceder a la página Portal mediante:

• Una invitación de un administrador de la organización Harmony a través de la Management Console Administración de usuarios página.

• Un enlace directo para consumidores de API que tienen permiso ApiConsumer en una organización y un mínimo de acceso de lectura en un ambiente (consulte Permisos y acceso a Harmony). Para obtener el enlace directo, copie la URL de la página Portal del API Manager o el enlace para Ver documentación de la API en la página Administrador del portal.

  Para obtener el enlace directo para proporcionárselo a un consumidor de API que tenga el permiso y el nivel de acceso requeridos, realice una de estas acciones:

  • Vaya a la página Portal y copie su URL.

  • Desde el Administrador del portal, haga clic en Ver documentación de API:

    

  Al acceder al enlace directo al Portal, si los usuarios aún no han iniciado sesión, se les presenta una página de inicio de sesión genérica que está separada de la página de inicio de sesión del Portal Harmony. Aunque la página de inicio de sesión es diferente a la que se muestra para Harmony Portal, las credenciales requeridas son las mismas que se utilizan para iniciar sesión en Harmony Portal.

  Después de iniciar sesión, se muestra la página Portal. La página Portal muestra la documentación de OpenAPI 2.0 generada desde el Portal Manager y le permite probar las APIs personalizadas y proxy.

Encabezado de Página del Portal¶

Estos detalles y acciones están disponibles en la parte superior de la página Portal:

• Organización: El nombre de la organización actualmente seleccionada al que se accede.

• URL base: La URL base de las APIs de la organización.

  • Copiar: Haga clic en el ícono de copiar para copiar la URL base en tu portapapeles.

• Ambiente: Muestra el ambiente al que se accede actualmente. Utilice el menú para seleccionar otro ambiente.

APIs de Prueba¶

Puede utilizar la documentación interactiva para probar las llamadas proxy de API para validar que funcionan correctamente.

Como la interfaz es la misma que la generada y descrita en la página Administrador del portal, consulte Probar APIs en el Administrador del portal página.