Página del portal en Jitterbit API Manager

Introducción

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

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

Acceder a la página del Portal

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

• Para cada API cuya documentación se vuelva accesible desde la página del Portal, se debe seleccionar un rol de organización que haya sido otorgado un mínimo de acceso Lectura en un entorno 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 de servicio OData

• La documentación de la API debe haberse generado y publicado previamente a través de la página del Portal Manager.

Para acceder a la página del Portal, utiliza el menú del portal de Harmony para seleccionar API Manager > Portal.

Además del acceso a través del menú del portal Harmony, la página Portal se puede acceder mediante:

• Una invitación de un administrador de organización de Harmony a través de la página Gestión de Usuarios de la Consola de Gestión.

• Un enlace directo para consumidores de API que tengan tanto el permiso ApiConsumer en una organización como un mínimo de acceso Lectura en un entorno (ver permisos y acceso de Harmony). Para obtener el enlace directo, copia ya sea la URL de la página Portal del Administrador de API o el enlace para Ver Documentación de API en la página del Administrador de Portal.

  Para obtener el enlace directo que se debe proporcionar a un consumidor de API que tenga el permiso y nivel de acceso requeridos, haz una de estas:

  • Ve a la página Portal y copia su URL.

  • Desde la página Administrador de Portal, haz clic en Ver Documentación de API:

    

  Al acceder al enlace directo al Portal, si los usuarios no han iniciado sesión, se les presenta una página de inicio de sesión genérica que es diferente 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 mostrada 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 OpenAPI 2.0 generada desde la página Administrador de Portal y permite probar 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 Portal:

• Organización: El nombre de la organización actualmente seleccionada que se está accediendo.

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

  • Copiar: Haz clic para copiar la URL base en tu portapapeles.

• Entorno: Muestra el entorno que se está accediendo actualmente. Usa el menú para seleccionar otro entorno.

Probar APIs

Puedes usar la documentación interactiva para probar llamadas a APIs personalizadas y de proxy con el fin de validar que están funcionando correctamente.

Como la interfaz es la misma que la generada y descrita en la página del Portal Manager, consulta Probar APIs en la página del Portal Manager.