Creación y configuración de catálogos

Cómo crear y configurar catálogos en IBM® API Connect.

Para crear y configurar el catálogo, siga estos pasos:

1. Inicie sesión en API Manager y haga clic en Manage.
2. Cree el catálogo.
   Puede crear el catálogo de las maneras siguientes:

   Especifique el propietario y, a continuación, configure el catálogo como se describe a continuación.

   1. Haga clic en Añadir > Crear catálogo.
   2. En el campo Propietario de catálogo, seleccione el propietario del catálogo.

      Por defecto, usted es el propietario. Sin embargo, puede especificar cualquier usuario que sea miembro de la organización proveedora.

   3. Continúe en el paso 3 para configurar el catálogo.

   Envíe un correo electrónico de invitación, con un enlace de activación, al propietario del catálogo previsto:

   1. Haga clic en Añadir > Invitar al propietario del catálogo.
   2. Especifique la dirección de correo electrónico del propietario de catálogo y pulse Invitar.
   3. Al recibir el correo electrónico, el propietario del catálogo debe activar el catálogo y configurarlo:
      1. Abra el enlace de activación, rellene el formulario de registro e inicie sesión en la interfaz de usuario del Gestor de API.
      2. Haga clic en Gestionar catálogos, haga clic en el nombre del catálogo que se proporcionó en el formulario de registro y, a continuación, haga clic en la pestaña Configuración del catálogo.
      3. Continúe en el paso 6 para configurar el catálogo.
3. Especifique el Títulodel catálogo. Se especifica automáticamente un Nombre, que no puede modificarse.
   Nota: El valor del campo Nombre es una serie única que se utiliza para identificar el catálogo en los mandatos de CLI developer toolkit . El Título se utiliza para la visualización; puede cambiar el título, pero el nombre no cambia.

   Para ver los comandos de la CLI para gestionar catálogos, consulte la documentación de referencia de la CLI del kit de herramientas.

4. Pulse Crear.
   El catálogo nuevo se visualiza en la página Gestionar.
5. Para continuar configurando el catálogo, seleccione el catálogo en la página Gestionar y, a continuación, pulse la pestaña Valores del catálogo.
6. Para configurar los parámetros generales del catálogo, haga clic en Descripción general y, a continuación, siga los pasos siguientes.
   1. Para utilizar el catálogo en producción, sitúe el control deslizante Modo de producción en la posición Activado y, a continuación, haga clic en Confirmar.

      De forma predeterminada, el nuevo catálogo es un catálogo de desarrollo.

      En un catálogo de desarrollo, se fuerzan todas las operaciones de publicación y los conflictos se resuelven automáticamente. Si vuelve a publicar una versión de producto publicada anteriormente, ésta se sobrescribe sin previo aviso, lo cual permite, por ejemplo, volver a publicar repetidamente la misma versión de producto durante las pruebas. Si los espacios están habilitados en un catálogo de desarrollo y vuelve a publicar una versión de producto publicada anteriormente en un espacio diferente, se elimina del espacio anterior.

      Sin embargo, si el catálogo se ha configurado para requerir aprobaciones, un catálogo de desarrollo se comporta igual que cualquier otro catálogo en lo que respecta a requerir aprobación para las acciones de puesta en escena y publicación.

      Nota: En un catálogo de producción, se aplican las condiciones siguientes:

      • No puede publicar un producto en el catálogo si ya hay un producto en el catálogo con el mismo nombre y versión. En su lugar, debe crear una nueva versión del producto para su publicación; consulte Creación de una nueva versión del producto . Si se han habilitado espacios en un catálogo de producción, no puede publicar un producto con el mismo nombre y versión en más de un espacio en el catálogo.
      • Si este nuevo producto contiene una o varias API modificadas, debe crear nuevas versiones de las API para incluirlas en el producto; consulte Creación de una nueva versión de una definición de API. Si el producto contiene una API modificada y ya existe una API publicada con el mismo nombre y versión, los cambios no se publican.
   2. Para habilitar la partición de este catálogo en espacios, establezca el control deslizante Espacios en la posición Activado y, a continuación, pulse Confirmar.
      Para obtener más información, consulte Uso de la sindicación en IBM API Connect.
   3. Si el catálogo es el catálogo de transferencia predeterminado, mueva el control deslizante Predeterminado a la posición Activado y, a continuación, pulse Confirmar. A continuación, las llamadas a las API publicadas en el catálogo, pueden utilizar un URL más corto que no incluye el nombre del catálogo.
      Nota: Puede habilitar Predeterminado sólo para un catálogo. Si ya hay otro catálogo configurado como catálogo por defecto, no podrá activar la configuración en este catálogo sin desactivar primero la configuración en el otro catálogo.
7. Para configurar los ajustes del servicio de puerta de enlace para el catálogo, haga clic en Servicios de puerta de enlace y, a continuación, siga los pasos siguientes.
   Nota: Si los espacios están habilitados en el catálogo, entonces se configuran los ajustes de la pasarela para los espacios, no para el catálogo en su conjunto.
   1. Pulse Editar.
   2. Seleccione los servicios de pasarela que desee utilizar con este catálogo.
   3. Pulse Guardar para guardar los cambios.
      La interfaz de usuario para crear o importar AsynchAPIs desde Event Endpoint Management está desactivada para los catálogos que no disponen del servicio Event Gateway. Si desea trabajar con AsynchAPIs en el catálogo, debe añadir un servicio Event Gateway al catálogo.

   Las API se publican añadiéndolas a un producto y, a continuación, publicando el producto en un catálogo. Para poder publicar productos en un catálogo, éste debe estar asignado al menos a un servicio de pasarela, de modo que las API del producto estén disponibles para ser llamadas en un punto final del servicio de pasarela. Puede asignar más de un servicio de pasarela a un catálogo, y pueden ser de tipos mixtos, DataPower® API Gateway y DataPower Gateway (v5 compatible).

   Un producto es específico del tipo de pasarela, ya sea DataPower API Gateway o DataPower Gateway (v5 compatible). De forma predeterminada, cuando publica un producto en un catálogo, se publica en todos los servicios de pasarela asignados del mismo tipo de pasarela que el producto, pero puede optar por publicar el producto sólo en los servicios de pasarela seleccionados, de ese tipo, en el momento de la publicación; consulte Publicación de un borrador de producto para obtener más información. Las API del producto están disponibles para ser llamadas en todos los puntos finales de servicio de pasarela especificados.

   Si selecciona dos o más servicios Gateway, entonces, para que los datos analíticos estén disponibles en el Portal del Desarrollador para este catálogo, los servicios Gateway deben estar todos asociados con el mismo servicio analítico. Si el conjunto de servicios de análisis asociados para los servicios de pasarela seleccionados incluye dos o más servicios de análisis diferentes, el portal para desarrolladores no mostrará los datos de análisis.

   Nota: También puede configurar los ajustes del servicio de puerta de enlace para el catálogo mediante la CLI del kit de herramientas para desarrolladores; para obtener más detalles, consulte la documentación de referencia de la CLI del kit de herramientas.
8. Para especificar los cambios de estado del ciclo de vida de producto para los que desee exigir aprobación, siga estos pasos:
   1. Haga clic en Aprobaciones del ciclo de vida en el panel de navegación de configuración del catálogo y, a continuación, en Editar.
   2. Seleccione los cambios de estado necesarios y, a continuación, pulse Guardar cuando haya terminado.
      Por ejemplo, si selecciona Publicar y deja desmarcadas las demás casillas de verificación, se requerirá aprobación cuando alguien intente publicar un producto, pero no se requerirá aprobación para ninguno de los demás cambios de estado del ciclo de vida.

      Nota: La aprobación de los cambios de estado del ciclo de vida del producto en un catálogo está inhabilitada de forma predeterminada. Debe habilitar explícitamente los cambios de estado de ciclo de vida de producto que desea imponer.
   3. Para permitir que el autor de un cambio en el ciclo de vida de un producto lo apruebe por sí mismo, mueva el control deslizante Autoaprobación de tareas a la posición Activado y, a continuación, haga clic en Confirmar.
      Nota: En un catálogo de desarrollo, el originador de un cambio de ciclo de vida de producto siempre puede aprobarlo él mismo. En un catálogo de producción, el autor de un cambio en el ciclo de vida de un producto puede aprobarlo por sí mismo sólo si la configuración del catálogo Autoaprobación de tareas está activada.
   4. Pulse Guardar.
9. Para configurar los permisos que tiene cada rol en API Manager, siga los siguientes pasos.
   1. Pulse Roles en el panel de navegación de valores de catálogo.
      Para ver los permisos actuales de un rol, expándalo.
   2. Haga clic en el icono de opciones situado junto a la función con la que desea trabajar y, a continuación, haga clic en Editar.
   3. Marque o desmarque los recuadros de selección de los permisos según sea necesario.

      Para asegurarse de que un rol puede gestionar políticas definidas por el usuario, seleccione Gestionar para el permiso Configuración.

      Para otorgar a un rol el permiso para aprobar un cambio de estado de ciclo de vida específico, seleccione el cambio de estado en la sección Aprobación de producto.

      Nota: No puede eliminar un permiso que se haya asignado al rol a nivel de organización de proveedores. Sin embargo, puede añadir permisos que no se han asignado en el nivel de organización de proveedores.
   4. Para asignar las funciones a los grupos, en Asignación externa de funciones, seleccione la casilla de verificación Activar asignación externa de grupos y, a continuación, introduzca la información necesaria en cada campo.
   5. Pulse Guardar.
10. Para gestionar la incorporación de consumidores de API en este catálogo, realice los pasos siguientes:
    1. Pulse Incorporación en el panel de navegación de valores de catálogo.
    2. Para seleccionar los registros que se utilizan para autenticar usuarios del Portal del desarrollador asociado con este catálogo, pulse Editar en la sección Registros de usuarios del catálogo , seleccione los registros necesarios y, a continuación, pulse Guardar.
       Para obtener más información sobre cómo configurar un registro de usuarios, consulte Autenticación mediante el registro de usuarios de la empresa.

       Importante: No comparta registros de usuarios entre el Administrador de API y el Portal para desarrolladores, o entre sitios del Portal para desarrolladores cuando la incorporación de autoservicio esté habilitada o se esperen eliminaciones de cuentas en cualquiera de los sitios. Debe crear registros de usuarios separados para ellos, incluso si los registros separados apuntan al mismo proveedor de autenticación de programa de fondo (por ejemplo, un servidor LDAP). Esta separación permite al Portal del Desarrollador mantener direcciones de correo electrónico únicas en todo el catálogo, sin que el Gestor de API necesite el mismo requisito. También evita problemas con los usuarios que eliminan sus cuentas del Portal del Desarrollador, lo que afecta a su acceso al Gestor de API.
    3. Para establecer un registro por defecto, localice el registro requerido y haga clic en Establecer por defecto.

       Cuando un usuario de la API se registra en el portal para desarrolladores, se utiliza por defecto el registro especificado, con la opción de seleccionar otro registro.

    4. Para permitir que los usuarios de la API completen su propio proceso de registro en el portal para desarrolladores, active la opción Incorporación de autoservicio.
       Si esta opción está desactivada, un consumidor de la API no puede registrarse sin una invitación del propietario de una organización de consumidores.
    5. Para requerir la aprobación de todos los nuevos autoservicios en el Portal del Desarrollador, establezca la Aprobación de autoservicios en Activado.
       Si esta opción está activada, cualquier intento por parte de un consumidor de la API de registrarse en el Portal del Desarrollador tendrá como resultado el envío de una solicitud de aprobación. Esta solicitud se muestra en la pestaña Tareas del catálogo del Portal del Programador asociado, desde donde se puede aprobar o rechazar la solicitud.

       La aprobación de incorporación de Autoservicio se cumple siempre que se crea una organización de consumidores. Por lo tanto, incluso si un consumidor de API ya ha sido aprobado para acceder a un Portal de Desarrolladores con una organización de consumidores específica, si luego intenta crear otra organización de consumidores en el mismo Portal de Desarrolladores, su solicitud seguirá pasando por el proceso de aprobación.

       Nota: Para habilitar la aprobación de incorporación de autoservicio, también debe completar las tareas siguientes:

       • Configure el registro de usuarios para que requiera la dirección de correo electrónico del usuario.
       • Configure las aplicaciones OIDC para enviar la dirección de correo electrónico del usuario para su aprobación.
    6. Para editar el periodo de tiempo de espera para la tarea de incorporación de autoservicio, pulse Editar en la sección Tiempo de espera de tarea de incorporación de autoservicio , especifique el periodo de tiempo de espera necesario y pulse Guardar. El periodo de tiempo de espera para esta tarea cubre tanto el enlace de activación de correo electrónico como, si la Aprobación de incorporación de autoservicio está habilitada, el proceso de aprobación. El periodo de tiempo de espera predeterminado para la tarea de incorporación de autoservicio es de 72 horas.
       Las tareas de autoaprendizaje caducadas sólo se borran una vez al día en el Portal del Desarrollador. Por lo tanto, los usuarios de la API cuyas tareas de registro hayan caducado deberán esperar a que se borren dichas tareas antes de intentar registrarse de nuevo.
    7. Para configurar la capacidad de los consumidores de API para invitar a colaboradores y asignarlos a roles, pulse Editar en la sección Invitación y roles de consumidor , seleccione las opciones necesarias y pulse Guardar.
    8. Para configurar el tiempo de espera para los enlaces de activación que se envían en invitaciones de correo electrónico a los desarrolladores de aplicaciones, pulse Editar en la sección Tiempo de espera de invitación , especifique la duración del tiempo de espera y, a continuación, pulse Guardar. El periodo de tiempo de espera predeterminado para el enlace de invitación es de 48 horas.
    9. Para alterar temporalmente los tiempos de espera establecidos por las invitaciones de la organización de consumidores, establezca Alterar temporalmente el tiempo de espera de invitación de la organización de consumidores con el tiempo de espera de invitación de catálogo en Activado.

       En su lugar, se utiliza el tiempo de espera del catálogo.

    Nota: La configuración del catálogo onboarding se aplica tanto al Catálogo del Consumidor como al Portal del Desarrollador.
11. Para especificar los registros de usuarios utilizados para proteger el acceso a las API de este catálogo y añadir el registro de usuarios al catálogo de recinto de pruebas, siga estos pasos:
    1. Haga clic en la pestaña Configuración del catálogo y, a continuación, seleccione Registros de usuario API.
    2. Pulse Editar y seleccione los registros de usuarios que desea utilizar.
       Para obtener más información sobre cómo configurar un registro de usuarios, consulte Autenticación mediante el registro de usuarios de la empresa.
    3. Haga clic en Guardar cuando haya terminado.
    Nota:

    • Sólo se pueden utilizar los registros LDAP y Authentication URL para proteger el acceso a las API. Por lo tanto, sólo los registros de estos tipos figuran en la lista y están disponibles para su selección.
    • Si los espacios están habilitados en el catálogo, entonces se especifican los registros de usuario para los espacios, no para el catálogo en su conjunto. Si especifica un registro de usuarios en un espacio de un catálogo, se despliega en los servicios de pasarela en todos los espacios de dicho catálogo.

      Para obtener más información sobre cómo habilitar y gestionar espacios, consulte Utilización de la sindicación en API Connect

      .
12. Para especificar los proveedores de OAuth que se pueden utilizar para proteger el acceso a las API de este catálogo, siga estos pasos.
    Nota:

    • Si desea especificar un proveedor de OAuth para un catálogo, asegúrese de que el catálogo de recinto de pruebas esté configurado para utilizar el mismo proveedor de OAuth
    • Los recursos a los que haga referencia el proveedor de OAuth, como por ejemplo registros de usuarios de API o perfiles de cliente TLS, también deben estar habilitados en el catálogo
    • Si los espacios están habilitados en el catálogo, entonces se especifican los proveedores OAuth para los espacios, no para el catálogo en su conjunto. Si especifica un proveedor OAuth en un espacio de un catálogo, se despliega en los servicios de pasarela en todos los espacios de dicho catálogo.

      Para obtener más información sobre cómo habilitar y gestionar espacios, consulte Utilización de la sindicación en API Connect.

    1. Haga clic en Proveedores OAuth en el panel de navegación de configuración del catálogo.
    2. Pulse Editary, a continuación, seleccione los proveedores OAuth que desea utilizar.

       Para configurar un proveedor de OAuth, consulte Configurar un proveedor de OAuth nativo mediante Cloud Manager o Configurar un proveedor de OAuth nativo mediante API Manager.

    3. Haga clic en Guardar cuando haya terminado.
13. Para configurar los perfiles de cliente TLS utilizados con este catálogo, siga estos pasos:
    Nota: Si se habilitan espacios en el catálogo, se configuran los perfiles de cliente TLS para los espacios, no para el catálogo en su conjunto. Si configura un perfil de cliente TLS en un espacio de un catálogo, se despliega en los servicios de pasarela en todos los espacios de dicho catálogo.

    Para obtener más información sobre cómo habilitar y gestionar espacios, consulte Utilización de la sindicación en API Connect.

    1. Haga clic en Perfiles de cliente TLS en el panel de navegación de configuración del catálogo.
    2. Pulse Editary, a continuación, seleccione los perfiles de cliente TLS que desea utilizar con este catálogo.
       Para más información sobre cómo crear un perfil de cliente TLS, consulte Crear un perfil de cliente TLS.
    3. Haga clic en Guardar cuando haya terminado.
14. Configurar un Portal del Desarrollador basado en el catálogo.
    1. Cree el portal:
       1. En el catálogo, haga clic en la pestaña Configuración del catálogo.
       2. En la página de configuración del catálogo, haga clic en Portal en la lista de navegación.
       3. En la página Portal , pulse Crear.
       4. En la página Crear portal, seleccione un servicio de portal.
       5. Pulse Crear para guardar los cambios.
       Si desea editar el servicio del portal o URL, o eliminar el sitio del portal, vuelva a la página de configuración del portal, haga clic en el icono Menú para seleccionar Eliminar o haga clic en la pestaña Editar.
    2. Opcional: Puede crear un nombre de host personalizado para el portal realizando los pasos siguientes.

       Al crear un portal para desarrolladores, API Connect genera una URL que los consumidores pueden utilizar para acceder al portal. Si desea que los consumidores utilicen una URL personalizada para el portal de desarrolladores, puede configurar un nombre de host personalizado para el portal que se utilizará en la URL. La configuración de un nombre de host personalizado requiere que configure un DNS con el CNAME.

       Paso 1: Configurar el nombre de host de Vanity:

       1. Configure su DNS deseado como un CNAME apuntando a la siguiente dirección:

          custom.<region>.apiconnect.ibmappdomain.cloud

          Donde <region> es la región donde está alojada su cuenta API Connect . Por ejemplo, para un cliente eu-central:

          custom.eu-central-a.apiconnect.ibmappdomain.cloud

          Nota: Los cambios de DNS a veces pueden tardar hasta 24 horas en llenarse.

       Paso 2: Configurar el nombre de host de Vanity para el Portal del desarrollador:

       1. En el catálogo, haga clic en la pestaña Configuración del catálogo.
       2. En la página de configuración del catálogo, haga clic en Portal en la lista de navegación.
       3. En la página Portal , pulse Editar.
       4. En la página del portal, configure el nombre de host de vanidad:
          1. En la sección "Sitio del portal", seleccione Utilizar nombre de host de Vanity.

             Cuando selecciona esta opción, se muestra un recordatorio para configurar el CNAME para el nombre de host de Vanity. Si aún no ha configurado el CNAME, haga clic en en el mensaje para copiar el URL y poder utilizarlo para configurar el CNAME.

          2. Escriba el nuevo nombre de host DNS personalizado; por ejemplo,: api.CustomHost.uk.
          3. Pulse Comprobar DNS para verificar que se puede acceder al host.

             El nombre de host ya debe estar configurado con un CNAME tal como se muestra en el recordatorio para configurar DNS. Si la comprobación de DNS falla, no puede continuar con este procedimiento y debe trabajar con el soporte de IBM para corregir el problema.

          4. Cuando la comprobación de DNS se realice correctamente, pulse Guardar.

             La página Valores del catálogo muestra los valores del portal actualizado.

15. Para definir propiedades de catálogo, siga estos pasos:
    1. Haga clic en Propiedades del catálogo en el panel de navegación de configuración del catálogo y, a continuación, haga clic en Crear.
    2. Introduzca el Nombre y el Valor de la propiedad.
    3. Seleccione la casilla Protegido para redactar la propiedad.
       Nota: Después de que la propiedad se crea como protegida, permanece redactada y el valor se representa como ******. Si desea que el valor sea visible, elimine la propiedad y vuelva a crearla sin seleccionar la opción Protegida.
    4. Pulse Crear.
    Puede hacerse referencia a las propiedades que defina en cualquiera de las definiciones de API de este catálogo. También es posible definir propiedades que son específicas de una definición de API; consulte Establecimiento de propiedades de API. Para obtener información sobre cómo hacer referencia a una propiedad en una definición de API, consulte Referencias a variables en API Connect.

    Nota:

    • Si define una propiedad de catálogo con el mismo nombre que una propiedad de API, esta tiene prioridad sobre la propiedad de catálogo.
    • Si cambia el valor de una propiedad de catálogo, cualquier API que haga referencia a esa propiedad se debe volver a publicar para que utilice el nuevo valor.
16. Opcional: Para configurar la visibilidad de los productos que se publican en un catálogo o un espacio, consulte Configuración de la visibilidad de los productos a nivel de catálogo o espacio.