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 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, 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.

Acceda 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 se vuelve accesible desde la página Portal, se debe seleccionar en la configuración de la API un rol de organización al 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 de la 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 Harmony o desde el menú de navegación del API Manager:

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

  

• Al acceder a una página de API Manager, utilice su menú de navegación 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 los consumidores de API que tienen permiso ApiConsumer en una organización y un mínimo de acceso Lectura en un ambiente (consulte Permisos y acceso de Harmony). Para obtener el enlace directo, copie la URL de la página Portal del API Manager o el enlace a Ver documentación de API en la página Administrador de Portal.

  Para obtener el enlace directo para proporcionarlo 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 página, 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 es independiente de la página de inicio de sesión del portal Harmony. Aunque la página de inicio de sesión se ve diferente de la que se muestra para el portal Harmony, las credenciales requeridas son las mismas que las utilizadas para iniciar sesión en el portal Harmony.

  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 Administrador de portal página y le permite probar APIs personalizadas y proxy.

Encabezado de la 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 está accediendo.

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

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

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

APIs de Prueba

Puede utilizar la documentación interactiva para probar llamadas API personalizadas y de proxy para validar que funcionen correctamente.

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