Portal¶

Introducción¶

La página del 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 de 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 del Portal a través de la aplicación API Manager, a través de una invitación de un administrador de la organización Harmony, o a través de 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 del Portal, se deben cumplir estos criterios:

• Para cada API cuya documentación sea accesible desde la página del Portal, se debe seleccionar un rol de organización al que se le haya otorgado un mínimo de acceso de lectura en un ambiente en la configuración de la API. 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 previamente generada y publicada a través del Portal Manager página.

Se puede acceder a la página del Portal desde el menú del Portal de Harmony 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:

  

• Desde Mis APIs, Administrador del portal, 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 Portal:

  

Además del acceso a través de la aplicación API Manager, se puede acceder a la página del 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 de ApiConsumer en una organización y un mínimo de acceso de Lectura en un ambiente (consulte Permisos y acceso de Jitterbit Harmony). Para obtener el enlace directo, copie la URL de la página del Portal del API Manager o el enlace para Ver la documentación de la API en la página del Administrador del portal.

  Para obtener el enlace directo para proporcionar a un consumidor de API que tenga el permiso y el nivel de acceso requeridos, haga uno de estos:

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

  • Del Portal Manager, copie el enlace a Ver documentación de la 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 a la que se muestra para el Portal de Harmony, las credenciales requeridas son las mismas que las utilizadas para iniciar sesión en el Portal de Harmony.

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

Encabezado de la Página del Portal¶

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

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

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

  • Copiar: Haz clic en el icono de copia para copiar la URL base en el portapapeles.

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

APIs de Prueba¶

Puede usar 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 del Portal Manager, consulte Probar APIs en el Administrador del portal página.