Tutorial: Crear y publicar un producto

SE APLICA A: Todos los niveles de API Management

En Azure API Management, un producto contiene una o varias API, una cuota de uso y las condiciones de uso. Una vez publicado un producto, los desarrolladores pueden suscribirse y comenzar a usar las API del producto.

En este tutorial, aprenderá a:

• Crear y publicar un producto
• Agregar una API al producto
• Acceder a las API de productos

Requisitos previos

• Conocer la terminología de API Management de Azure.
• Complete el siguiente inicio rápido: Creación de una instancia de Azure API Management.
• Además, realice el siguiente tutorial: Importación y publicación de la primera API.

Crear y publicar un producto

Portal

1. Inicie sesión en Azure Portal y vaya a la instancia de API Management.

2. En el panel de navegación izquierdo, seleccione Productos>+ Agregar.

   

3. En la ventana Agregar producto, escriba los valores que se describen en la tabla siguiente para crear el producto.

   

   Nombre	Descripción
   Nombre para mostrar	El nombre que desea que aparezca en el portal para desarrolladores.
   Descripción	Proporcione información sobre el producto, como su finalidad, las API a las que proporciona acceso y otros detalles.
   State	Seleccione Publicado si quiere publicar el producto. Para poder llamar a las API de un producto, este debe publicarse. De forma predeterminada, los nuevos productos no se publican y solo son visibles para el grupo Administradores.
   Requiere suscripción	Seleccione si un usuario debe suscribirse para usar el producto (el producto está protegido) y si se debe usar una clave de suscripción para acceder a las API del producto. Si no se requiere una suscripción (el producto está abierto), no se requiere una clave de suscripción para acceder a las API del producto. Consulte Acceder a las API de producto más adelante en este artículo.
   Requiere aprobación	Seleccione si quiere que un administrador revise y acepte o rechace los intentos de suscripción a este producto. Si no se selecciona, los intentos de suscripción se aprueban automáticamente.
   Límite de recuento de suscripciones	Tiene la opción de limitar el número de varias suscripciones simultáneas.
   Términos legales	Puede incluir los términos de uso del producto que deben aceptar los suscriptores para usarlo.
   API existentes	Seleccione una o varias API. También puede agregar las API después de crear el producto. Para más información, consulte Incorporación de las API a un producto más adelante en este artículo. Si el producto está abierto (no requiere una suscripción), solo puede agregar una API que no esté asociada ya a otro producto abierto.

4. Seleccione Crear para crear el producto.

Precaución

Tenga cuidado al configurar un producto que no requiera una suscripción. Esta configuración puede ser excesivamente permisiva y hacer que la API del producto sea más vulnerable a determinadas amenazas de seguridad de API.

CLI de Azure

Para empezar a usar la CLI de Azure:

• Use el entorno de Bash en Azure Cloud Shell. Para más información, consulte Inicio rápido para Bash en Azure Cloud Shell.

  

• Si prefiere ejecutar comandos de referencia de la CLI localmente, instale la CLI de Azure. Si utiliza Windows o macOS, considere la posibilidad de ejecutar la CLI de Azure en un contenedor Docker. Para más información, vea Ejecución de la CLI de Azure en un contenedor de Docker.

  • Si usa una instalación local, inicie sesión en la CLI de Azure mediante el comando az login. Siga los pasos que se muestran en el terminal para completar el proceso de autenticación. Para ver otras opciones de inicio de sesión, consulte Inicio de sesión con la CLI de Azure.

  • En caso de que se le solicite, instale las extensiones de la CLI de Azure la primera vez que la use. Para más información sobre las extensiones, consulte Uso de extensiones con la CLI de Azure.

  • Ejecute az version para buscar cuál es la versión y las bibliotecas dependientes que están instaladas. Para realizar la actualización a la versión más reciente, ejecute az upgrade.

Para crear un producto, ejecute el comando az apim product create:

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

Puede especificar varios valores para el producto:

Parámetro	Descripción
--product-name	El nombre que desea que aparezca en el portal para desarrolladores.
--description	Proporcione información sobre el producto, como su finalidad, las API a las que proporciona acceso y otros detalles.
--state	Seleccione Publicado si quiere publicar el producto. Para poder llamar a las API de un producto, este debe publicarse. De forma predeterminada, los nuevos productos no se publican y solo son visibles para el grupo Administradores.
--subscription-required	Seleccione si un usuario debe suscribirse para usar el producto (el producto está protegido) o si no se requiere una suscripción (el producto está abierto). Consulte Acceder a las API de producto más adelante en este artículo.
--approval-required	Seleccione si quiere que un administrador revise y acepte o rechace los intentos de suscripción a este producto. Si no se selecciona, los intentos de suscripción se aprueban automáticamente.
--subscriptions-limit	También tiene la opción de limitar el número de varias suscripciones simultáneas.
--legal-terms	Puede incluir las condiciones de uso del producto, que los suscriptores deben aceptar para usarlo.

Precaución

Tenga cuidado al configurar un producto que no requiera una suscripción. Esta configuración puede ser excesivamente permisiva y hacer que la API del producto sea más vulnerable a determinadas amenazas de seguridad de API.

Para ver los productos actuales, utilice el comando az apim product list:

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

Puede eliminar un producto mediante el comando az apim product delete:

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

Adición de más configuraciones

Siga configurando el producto después de guardarlo. En la instancia de API Management, seleccione el producto en la ventana Productos. Agregue o actualice:

Elemento	Descripción
Configuración	Los metadatos y el estado del producto
API existentes	Las API asociadas al producto.
Directivas	Las directivas aplicadas a las API de producto
Control de acceso	La visibilidad del producto para desarrolladores o invitados
Suscripciones	Los suscriptores a los productos

Incorporación de API a un producto

Los productos son asociaciones de una o varias API. Puede incluir muchas API y ofrecerlas a los desarrolladores mediante el portal para desarrolladores. Durante la creación del producto, puede agregar una o varias API existentes. También puede agregar las API al producto más adelante, bien desde la página Configuración de los productos o durante la creación de una API.

Adición de una API a un producto existente

Portal

1. En el panel de navegación izquierdo de la instancia de API Management, seleccione Productos.
2. Seleccione un producto y luego API.
3. Seleccione + Agregar API.
4. Seleccione una o varias API y luego Seleccionar.

CLI de Azure

1. Para ver las API administradas, utilice el comando az apim api list:

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. Para agregar una API al producto, ejecute el comando az apim product api add:

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. Compruebe la adición con el comando az apim product api list:

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

Puede eliminar una API de un producto con el comando az apim product api delete:

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

Acceder a las API de productos

Después de que se publique un producto, los desarrolladores pueden acceder a las API. Dependiendo de cómo se configure el producto, es posible que deban suscribirse al producto para acceder.

• Producto protegido: los desarrolladores deben suscribirse primero a un producto protegido para obtener acceso a las API del producto. Cuando se suscriben, obtienen una clave de suscripción que puede acceder a cualquier API de ese producto. Si creó la instancia de API Management, ya es un administrador, así que de forma predeterminada está suscrito a todos los productos. Para más información, consulte Suscripciones en Azure API Management.

  Cuando un cliente realiza una solicitud de API con una clave de suscripción de producto válida, API Management procesa la solicitud y permite el acceso en el contexto del producto. Es posible aplicar directivas y reglas de control de acceso configuradas para el producto.

  Sugerencia

  Puede crear o actualizar la suscripción del usuario a un producto con claves de suscripción personalizadas mediante la API REST o un comando de PowerShell.

• Abrir producto: los desarrolladores pueden acceder a las API de un producto abierto sin una clave de suscripción. Sin embargo, puede configurar otros mecanismos para proteger el acceso del cliente a las API, como OAuth 2.0, certificados de cliente y restricción de las direcciones IP del autor de la llamada.

  Nota

  Los productos abiertos no aparecen en el portal para desarrolladores para que puedan obtener información sobre los mismos o suscribirse a ellos. Solo son visibles para el grupo Administradores. Deberá usar otro mecanismo para informar a los desarrolladores sobre las API a las que se puede acceder sin una clave de suscripción.

  Cuando un cliente realiza una solicitud de API sin tener una clave de suscripción:

  • API Management comprueba si la API está asociada a un producto abierto. Una API se puede asociar como máximo a un producto abierto.

  • Si el producto abierto existe, procesa la solicitud en el contexto de ese producto abierto. Se pueden aplicar directivas y reglas de control de acceso configuradas para el producto abierto.

Para más información, vea Cómo gestiona API Management solicitudes con o sin claves de suscripción.

Pasos siguientes

En este tutorial, ha aprendido a:

• Crear y publicar un producto
• Agregar una API al producto
• Acceder a las API de productos

Avance hasta el siguiente tutorial:

Create blank API and mock API responses (Creación de una API en blanco y simulación de respuestas de API)