Publicación de un borrador de producto

Editar en línea

Publica un borrador del producto para que las API de dicho producto aparezcan en el Catálogo de consumidores y puedan utilizarlas los desarrolladores de aplicaciones. La función de sindicación de IBM® API Connect implica que, si se han habilitado los espacios para un catálogo, los productos solo se pueden publicar en un espacio dentro de ese catálogo.

Antes de empezar

Asegúrese de que tiene un catálogo al que transferir en las interfaces de usuario (IU) de API Manager o API Designer . Para obtener más información, consulte Creación y configuración de catálogos.

Nota: Todas las referencias de este tema a un catálogo también se pueden aplicar a Espacios en un catálogo, a menos que se especifique lo contrario. Para obtener más información sobre Spaces, consulta «Uso de la sindicación en API Connect...».

Para realizar las tareas de gestión de productos que se describen en este tema, debe ser el propietario de la organización proveedora de la API o tener asignado el permiso «Producto > Gestionar» para el catálogo o el espacio de destino. Para obtener información sobre cómo configurar permisos de gestión de productos para un catálogo o Espacio, consulte Creación y configuración de catálogos o Gestión del acceso de usuario en un espacio.

Acerca de esta tarea

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador. La publicación no está disponible cuando se trabaja fuera de línea en API Designer.

No es posible volver a publicar una versión del producto en un catálogo de producción; debe crear una nueva versión del producto para su publicación; consulte «Creación de una nueva versión del producto ». Si los Espacios están habilitados en un catálogo de producción, no puede volver a publicar la misma versión del producto en ningún Espacio del catálogo, ni el mismo Espacio ni un Espaciodiferente.

No obstante, puede volver a publicar una versión del producto en el catálogo de Sandbox o en otro catálogo que no sea de producción para facilitar la prueba iterativa. Al volver a publicar una versión de producto en un catálogo que no es producción, puede elegir si desea conservar las suscripciones de aplicación; la supresión de las suscripciones puede facilitar el despliegue por scripts en un entorno de integración continua, en el que la recreación de suscripciones de aplicación estará controlador por los scripts.

Si los Espacios están habilitados en un catálogo que no es de producción y vuelve a publicar una versión del producto en un Espacio distinto al espacio en el que se ha publicado anteriormente, se elimina del Espacio anterior y se publica en el Espaciorecién especificado.

La validación del archivo de definición de API se produce durante el proceso de transferencia o publicación. Se produce la validación siguiente:

Validación en el esquema OpenAPI utilizando el analizador Swagger de herramientas de desarrollo de API (https://www.npmjs.com/package/@apidevtools/swagger-parser).
Validación con respecto a las propiedades de extensión de IBM .
Validación semántica, que incluye los tipos de validación siguientes:
- Garantizar que si una OpenAPI es aplicada por una pasarela API Connect, entonces el esquema debe ser HTTPS, o el nombre del parámetro para un esquema de seguridad de clave API en la cabecera debe ser X-IBM-Client-Id o X-IBM-Client-Secret.
- Asegúrese de que si una API Connect Gatewayno aplica OpenAPI , se debe proporcionar un host .
- Desreferenciar las referencias locales en el archivo de definición (es decir, los valores de las propiedades $ref ) y asegurarse de que son punteros JSON válidos dentro del archivo.

Nota: Si el archivo OpenAPI que define la API utiliza un campo $ref para hacer referencia a un fragmento de código OpenAPI que está definido en un archivo aparte, el campo $ref se sustituye por el contenido del archivo de destino antes de que el producto que contiene la API se transfiera o publique (el campo $ref sólo está soportado si está utilizando el API Connect kit de herramientas de desarrollador). Para obtener más información, consulte Utilización de $ref para reutilizar fragmentos de código en los archivos OpenAPI.

Procedimiento

Para publicar un producto, lleve a cabo los pasos siguientes:

Opcional: Si tiene cuentas en varias organizaciones de proveedores, puede seleccionar una nueva organización de proveedores para transferir y publicar en el menú Organización .
En el panel de navegación, haz clic en «Desarrollo ».
Seleccione el separador Productos .
Puede publicar un producto desde la página de listado Desarrollar o desde el propio producto.
1. Para publicar un producto desde la página de listado de Develop, haz clic en el icono del menú de opciones situado junto a la versión del producto deseada y, a continuación, selecciona «Publicar ».
  Si vuelve a publicar un producto en un catálogo que no es de producción y el producto tiene suscripciones de aplicación, la opción Publicar las suprime. Para conservar las suscripciones de aplicación, pulse Publicar (Conservar suscripciones).
  Nota: Si hay suscripciones existentes al producto, la operación Publicar (Conservar Suscripciones) fallará si elimina organizaciones de consumidores o grupos de organizaciones de consumidores de los valores de visibilidad o capacidad de suscripción del producto; sin embargo, puede añadir más organizaciones o grupos.
  Para obtener información sobre la gestión de valores de visibilidad y capacidad de suscripción, consulte Edición de un borrador de producto.
  Para obtener información sobre los grupos de organizaciones de consumidores, consulte Trabajar con grupos de organizaciones de consumidores.
2. Para publicar un producto desde el propio producto, siga estos pasos:
  1. Pulse la versión de producto con la que desea trabajar.
  2. Haz clic en el icono del menú de opciones:
  3. Seleccione Publicar.
Seleccione el catálogo en el que desea publicar el producto. Debe tener un tipo de pasarela compatible asociado con el catálogo para continuar, tal como se describe en Creación y configuración de catálogos.
Si se han habilitado Espacios en el catálogo seleccionado, seleccione el Espacio que necesite.

Nota: Los Catálogos entre los que puede seleccionar son los definidos para el servidor de gestión y la organización de proveedores a los que está conectado.
Si utiliza la interfaz de usuario Gestor de API, los detalles de la conexión vienen determinados por la dirección Gestor de API URL que abra y el identificador de usuario con el que se conecte. Si utiliza la interfaz de usuario de API Designer, debe introducir los datos del servidor de gestión y el ID de usuario en la ventana de inicio de sesión que se abre al iniciar API Designer por primera vez; consulte «Inicio de sesión en API Designer ».
Para obtener detalles sobre cómo crear un catálogo en una organización de proveedores, consulte Creación y configuración de catálogos.
Si desea publicar el producto sólo en los servicios Gateway seleccionados, seleccione Publicar en servicios Gateway específicosy, a continuación, seleccione los servicios Gateway necesarios. Sólo se listan los servicios de pasarela cuyo tipo coincide con el valor de tipo de pasarela del producto. Para obtener información sobre los tipos de pasarela, consulte API Connect «Tipos de pasarela ».
Las secciones Visibilidad y Capacidad de suscripción muestran los valores de visibilidad y capacidad de suscripción que se han configurado para el borrador del producto, pero puede modificarlos antes de publicarlos si es necesario; haga lo siguiente:
1. En la sección Visibilidad , especifique los usuarios para los que desea que el producto sea visible. Puede elegir Público para que el producto sea visible para todos los usuarios, Autenticado para que el producto esté disponible para los usuarios que se han autenticado correctamente o Personalizado para especificar las organizaciones de consumidores y los grupos de organizaciones de consumidores para los que desea que el producto sea visible.
  Si selecciona Personalizado, utilice el campo Tipo para añadir organizaciones para buscar las organizaciones de consumidores y los grupos de organizaciones de consumidores, en el catálogo seleccionado, para los que desea que el producto sea visible. Para obtener información sobre cómo crear y gestionar organizaciones de consumidores y grupos de organizaciones de consumidores, consulte Administración de organizaciones de consumidores.
2. En la sección Suscripción , especifique los usuarios que pueden suscribirse a los planes en el producto. Puede elegir Autenticado para hacer que los usuarios que se hayan autenticado satisfactoriamente puedan suscribirse a los planes del producto, o Personalizado para especificar las organizaciones de consumidores y grupos de organizaciones de consumidores que se pueden suscribir a los planes del producto.
  Si selecciona Personalizado, utilice el campo Buscar organizaciones y grupos para buscar las organizaciones de consumidores y los grupos de organizaciones de consumidores, en el catálogo seleccionado, al que desea que se pueda suscribir el producto. Si ha seleccionado visibilidad personalizada, sólo las organizaciones de consumidores y los grupos de organizaciones de consumidores seleccionados están disponibles para añadirlos a la lista de capacidad de suscripción personalizada. Para obtener información sobre cómo crear y gestionar organizaciones de consumidores y grupos de organizaciones de consumidores, consulte Administración de organizaciones de consumidores.
  Nota:
  - Si selecciona visibilidad personalizada o capacidad de suscripción, sólo se visualizan 10 resultados de búsqueda en la lista de selección para las organizaciones de consumidores y los grupos de organizaciones de consumidores. Si es necesario, especifique una serie de búsqueda más específica para refinar la búsqueda.
  - Si la visibilidad personalizada o la capacidad de suscripción ya se ha configurado en el borrador de producto, los títulos que se muestran en la tabla de organizaciones y grupos seleccionados se obtienen tomando los nombres definidos en el borrador de producto y buscando los títulos correspondientes en el catálogo que se ha seleccionado como destino de publicación.
Pulse Publicar.

Resultados

El producto se publica en un catálogo. El estado del producto se muestra como Publicado en la cabecera del propio producto y puede pulsar Publicado para ver en qué catálogos o espacios se publica el producto.

También puedes consultar el estado del producto en el Catálogo de API Manager. Si ha publicado el producto desde API Designer, asegúrese de que ha iniciado sesión en Gestor de API con el mismo nombre de usuario y contraseña que ha utilizado para API Designer. Haga clic en Icono Gestionar en el panel de navegación de la interfaz de usuario de API Manager «Gestionar» en la interfaz de usuario del Administrador de API y, a continuación, seleccione el catálogo deseado. El producto se muestra con un estado Publicado.

Si tu producto es DataPower® API Gateway compatible, están disponibles los siguientes estados:

Puesta en escena: Éxito: El producto se ha implementado correctamente y está listo para su publicación. Esta fase prepara el producto para su inclusión en el catálogo.
En proceso de publicación: El producto se ha publicado en el catálogo. Se está realizando la publicación en la(s) pasarela(s).
published-success: El producto se ha publicado correctamente en el catálogo y en los portales.
published-failed: El producto se ha publicado en el catálogo, pero no se ha podido publicar en los portales.
Nota:
Si el producto se publica en varias pasarelas, es posible que la operación se realice correctamente en algunas y falle en otras.
Puedes ver el estado de cada puerta de enlace desplegando el panel. Las API en este estado no se pueden invocar. Aunque todavía se pueden crear suscripciones, no funcionarán como se espera.
En desuso - En curso: El producto está quedando obsoleto en el catálogo, y el proceso de obsolescencia ya está en marcha en las pasarelas. Durante esta fase, se restringen las nuevas suscripciones y se prepara el producto para su retirada.
deprecated-success: Este producto ha quedado obsoleto. Las suscripciones existentes siguen activas, pero se han bloqueado las nuevas suscripciones.
Obsoleto - Fallo: El producto está marcado como obsoleto en el catálogo, pero la marca de obsoleto no se ha aplicado correctamente en la(s) pasarela(s). Dado que el estado del catálogo es «Obsoleto», se han bloqueado las nuevas suscripciones. Las suscripciones actuales siguen activas.
En proceso de jubilación: El producto se va a retirar del catálogo, y el proceso de retirada ya está en marcha en las pasarelas.
Jubilado - Éxito: El producto ha sido retirado del mercado. Ya no está disponible y todas las suscripciones han sido canceladas.
Retirado - Fallido: El producto se ha retirado del catálogo, pero la retirada no se ha completado correctamente en la(s) pasarela(s).
Nota:
Si el producto se retira de varias pasarelas, es posible que la operación se realice correctamente en algunas y falle en otras.
Puedes ver el estado de cada puerta de enlace desplegando el panel. En los Gateways en los que falla la retirada, el producto permanece en estado «Publicado» y todas las suscripciones siguen activas.

Para obtener más información sobre el estado de un producto, haz clic en el icono de Icono de información

información situado junto al producto. Se abre una ventana con los detalles del estado del producto. Muestra el plan, la suscripción y el estado del producto.

Nota: Estos DataPower Gateway (v5 compatible) productos no cuentan con esta función.

Si es necesario, puedes ocultar la información sobre el estado de los productos en la página de productos; consulta la sección «Desactivar la información sobre el estado en la página de productos ».

Para obtener información sobre el ciclo de vida de un producto, consulte El ciclo de vida del producto.

Si se requiere autorización para publicar productos en el catálogo, se envía una solicitud de autorización de publicación y el producto pasa al estado de publicación; el producto se publica en el catálogo cuando se aprueba la solicitud. Si no se requiere aprobación, el producto se publica inmediatamente.

Nota: Si es necesaria la aprobación para transferir productos al catálogo, se envía una solicitud de aprobación de etapa. Cuando se aprueba la solicitud, el producto pasa al estado desplegado y se debe publicar por separado en el catálogo. Para obtener información sobre la publicación de un producto por etapas en un catálogo, consulte Publicación de un producto.

Para obtener más información sobre cómo configurar las aprobaciones del ciclo de vida del producto para un catálogo, consulte «Creación y configuración de catálogos ». Para obtener más información sobre cómo aprobar solicitudes, consulta «Aprobación de solicitudes relacionadas con el ciclo de vida de los productos y las suscripciones ».

Si el producto no contiene planes, se añade automáticamente un plan denominado Plan predeterminado al producto en el catálogo.