

# Productos de portal en API Gateway
<a name="apigateway-portals-portal-product"></a>

Un *producto del portal* representa un servicio o una funcionalidad que desea compartir. El producto del portal es una recopilación de puntos de conexión REST de productos y páginas de productos. Los *puntos de conexión REST de productos* son los puntos de acceso al producto del portal y constan de la ruta y el método de una API de REST y la fase en la que se implementa. Las *páginas de productos* son documentación que proporciona para explicar cómo los consumidores de API pueden utilizar los puntos de conexión de los productos. Un producto del portal puede contener toda la etapa `Prod` como una recopilación de puntos de conexión REST del producto o solo el recurso `GET /pets` implementado en la etapa `Prod` como un punto de conexión REST de un producto único.

El producto del portal es personalizable. Puede agregar documentación personalizada, cambiar el nombre de los puntos de conexión REST del producto, reorganizar el orden de visualización, agregar nuevas secciones y compartir productos entre cuentas de AWS. Para que los cambios que realice en el producto del portal surtan efecto, debe volver a publicar todos los portales que utilicen ese producto del portal.

## Ejemplo de producto del portal de adopción de mascotas
<a name="apigateway-portals-portal-product-example"></a>

Por ejemplo, podría tener varias API de REST que representen un servicio de adopción de mascotas. Podría usar API Gateway para crear un producto del portal de `pet adoption`. Este producto del portal ayudaría a los clientes a detectar qué API deberían usar para conocer y adoptar mascotas. Este producto del portal utiliza las API de REST que ya ha creado, pero le permite reagruparlas y organizarlas. También puede proporcionar documentación sobre los términos y condiciones del uso del producto de portal de adopción de mascotas y permitir que los clientes prueben las API. Toda esta información se almacena en el producto del portal.

En la siguiente tabla se muestran tres API que representan un producto de portal de adopción de mascotas y los nombres de las operaciones de los puntos de conexión REST de los productos correspondientes y los nombres de las secciones de página.


| ID de la API de REST | Ruta y método de la API de REST | Etapa de la API de REST | Nombre de operación | Sección de la página | 
| --- | --- | --- | --- | --- | 
| kf5387miad |  GET /dogs  | Prod. |  View dogs  |  AdoptAnimals  | 
| kf5387miad  | GET /dogs/\$1dogId\$1  | Prod. | View dog  | AdoptAnimals  | 
| ra8obxcevg  | GET /cats  | Prod. | View cats  | AdoptAnimals  | 
| ra8obxcevg  | GET /cats/\$1catId\$1  | Prod. | View cat  | AdoptAnimals  | 
| h0rpx9cm62  |  ANY /user/\$1userId\$1/\$1petId\$1\$1  | Beta | Request visit  | AdoptProcess  | 

En este ejemplo, dos API de REST, `ra8obxcevg` y `kf5387miad`, se agrupan en la sección `AdoptAnimals`. El resultado de ordenar la navegación tendría el siguiente aspecto en un portal:

![\[Portal de adopción de mascotas\]](http://docs.aws.amazon.com/es_es/apigateway/latest/developerguide/images/apigateway-portal.png)


Como el método `ANY` es un método general, el portal muestra todos los métodos HTTP compatibles. Este portal también contiene documentación creada por el propietario del producto del portal.

## Pasos a seguir a continuación
<a name="apigateway-portals-portal-product-next-steps"></a>

Para empezar a utilizar los productos del portal, puede hacer lo siguiente:
+ Para crear un producto del portal, consulte [Creación de un producto del portal en API Gateway](apigateway-portals-create-portal-product.md).
+ Para obtener información sobre la función de prueba, consulte [Habilitación de una prueba para un punto de conexión REST de un producto de API Gateway en el portal](apigateway-portals-try-it.md).
+ Para obtener información sobre páginas del producto, consulte [Creación de una página de producto en API Gateway](apigateway-portals-create-product-page.md).
+ Para obtener información sobre cómo compartir el producto del portal, consulte [Uso compartido de productos de portal en API Gateway](apigateway-portals-share-resources.md).

Tras crear un producto de portal, puede publicarlo en un portal. Para obtener más información, consulte [Creación de un portal en API Gateway](apigateway-portals-create-portal.md).

# Creación de un producto del portal en API Gateway
<a name="apigateway-portals-create-portal-product"></a>

El procedimiento siguiente muestra cómo crear un producto del portal. Un portal es una recopilación de *productos del portal*. Tras crear el producto del portal, cree puntos de conexión REST del producto y las páginas del producto. Para obtener información sobre los productos del portal, consulte [Productos de portal en API Gateway](apigateway-portals-portal-product.md).

## Consideraciones
<a name="apigateway-portals-portal-product-considerations"></a>

Las siguientes consideraciones pueden afectar a cómo cree un producto del portal:
+ El producto del portal puede contener API de REST públicas y privadas. Las API privadas no son compatibles con la funcionalidad de prueba y, por lo tanto, tienen una diferencia visual en el portal. Como propietario de un portal, es posible que tenga que proporcionar documentación para explicar esto.
+ Si crea el producto del portal con la AWS CLI o los AWS SDK, el portal no tendrá puntos de conexión ni páginas de productos. Debe agregar estos recursos mediante la AWS CLI o la consola. Para obtener información sobre cómo crear un punto de conexión REST de producto, consulte [Creación de un punto de conexión REST del producto en API Gateway](apigateway-portals-create-product-rest-endpoint.md). Para obtener información sobre cómo crear una página de producto, consulte [Creación de una página de producto en API Gateway](apigateway-portals-create-product-page.md).

## Creación de un producto del portal
<a name="apigateway-portals-portal-product-create"></a>

El procedimiento siguiente muestra cómo crear un producto del portal.

**Creación de un producto del portal**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. En el panel de navegación principal, elija **Productos de portales**.

1. Seleccione **Crear producto**.

1. Para **Nombre del producto**, ingrese el nombre del producto del portal.

1. Para **Descripción del producto**, ingrese una descripción.

1. Elija **Siguiente**.

1. Para seleccionar los puntos de conexión REST del producto, en los **puntos de conexión de la API**, elija una API y, a continuación, elija una etapa.

1. Para agregar un punto de conexión a los puntos de conexión REST del producto, seleccione el punto de conexión de la API y, a continuación, elija **Agregar al producto**.
**nota**  
No elija **Siguiente** sin antes elegir **Agregar al producto**.  

![\[Producto del portal\]](http://docs.aws.amazon.com/es_es/apigateway/latest/developerguide/images/apigateway-portal-product.png)


   El punto de conexión de la API aparecerá en la lista de **puntos de conexión de la API seleccionados**.

1. Elija **Siguiente**.

1. Revise la selección y elija **Crear producto**.

Después de crear el producto del portal mediante la consola, todas las páginas del producto y las páginas de punto de conexión REST del producto son borradores y no aparecerán en el portal. Para que las páginas de los productos y las páginas de punto de conexión de REST de los productos estén visibles para los consumidores, debe agregar el borrador a una sección. Si crea el producto del portal con la AWS CLI o los AWS SDK, agregue el borrador a la sección en el comando AWS CLI. Independientemente de cómo agrega el borrador a una sección, debe publicar el portal que utiliza los productos del portal para que los consumidores puedan verlo.

**Agregación del borrador a una sección de la página**

1. Los borradores se muestran en la pestaña **Documentación**. Hay **borradores de páginas de documentación** para las páginas de productos y **borradores de páginas de referencia de API** para las páginas de punto de conexión REST de los productos. Elija **Borradores de páginas de referencia de la API**.

1. Elija un borrador de páginas de referencia de la API.

   Si no tiene ningún punto de conexión REST de productos, no tendrá ningún borrador de las páginas de referencia de la API. Para obtener información sobre cómo crear un punto de conexión REST de producto, consulte [Creación de un punto de conexión REST del producto en API Gateway](apigateway-portals-create-product-rest-endpoint.md).

1. Elija **Editar página**.

1. En esta página, puede sobrescribir cualquier parte de la documentación de la API existente o utilizar la documentación de API Gateway. Para que los consumidores puedan ver el contenido de la página de punto de conexión REST del producto, ingrese un nombre en **Nombre de sección**. Si este fuera el punto de conexión de `/pets-GET`, el nombre de la página podría ser `Pets`.

1. Seleccione **Save changes (Guardar cambios)**.

1. El nombre de la nueva página que ha creado aparece en la sección **páginas de referencia de la API**.

   Para que los consumidores puedan ver la nueva página, igual tendrá que volver a publicar el portal. Para obtener más información, consulte [Publicación de un portal en API Gateway](apigateway-portals-publish-portal.md). 

# Creación de un punto de conexión REST del producto en API Gateway
<a name="apigateway-portals-create-product-rest-endpoint"></a>

Un punto de conexión REST de un producto es un punto de acceso al producto del portal. Cada punto de conexión consta de la ruta y el método de una API de REST y de la fase en la que se implementa. El punto de conexión incluye toda la documentación que haya definido para la API de REST o se puede actualizar con documentación personalizada. Al crear el punto de conexión REST del producto, se configuran los siguientes ajustes:
+ El nombre de la operación del punto de conexión REST del producto. Si la API de REST tiene la ruta y el método `GET /pets`, en un portal, el nombre es `/pets`. Con el nombre de la operación, puede cambiar el nombre del punto de conexión REST del producto a `Pet summaries`. Esto no afectará a la API existente.
+ La función de prueba para el punto de conexión del producto. Esto permite a los consumidores de API probar las API en el portal. Si crea un punto de conexión de producto para una API privada, la función de prueba se establece en `UNAVAILABLE`. Para obtener más información, consulte [Habilitación de una prueba para un punto de conexión REST de un producto de API Gateway en el portal](apigateway-portals-try-it.md).
+ Si actualmente tienes partes de documentación definidas para la API de REST, puede importar la documentación o invalidar la documentación existente y crear nueva documentación por producto mediante [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). Las invalidaciones de documentación no se propagan a las partes de la documentación de la API de API Gateway. Si importa las partes de la documentación actual, API Gateway sincroniza los cambios en la API con el punto de conexión REST del producto.

## Creación de un punto de conexión REST del producto
<a name="apigateway-portals-create-product-rest-endpoint-create"></a>

En el siguiente procedimiento, se muestra cómo agregar un punto de conexión REST de producto a un producto existente del portal. Para obtener información sobre cómo crear un producto de portal y un punto de conexión REST de producto juntos, consulte [Creación de un producto del portal en API Gateway](apigateway-portals-create-portal-product.md).

**Creación de un punto de conexión REST de un producto para un portal de productos**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. En el panel de navegación principal, elija **Productos de portales**.

1. Elija un producto del portal.

1. Elija la pestaña **Puntos de conexión asociados** y, a continuación, elija **Agregar puntos de conexión**.

1. Para seleccionar los puntos de conexión REST del producto, en los **puntos de conexión de la API**, elija una API y, a continuación, elija una etapa.

1. Para agregar un punto de conexión a los puntos de conexión REST del producto, seleccione el punto de conexión de la API y, a continuación, elija **Agregar al producto**.

   El punto de conexión de la API aparecerá en la lista de **puntos de conexión de la API seleccionados**.

1. Elija **Enviar**.

1. La página de punto de conexión REST del producto es ahora un borrador. Elija **Borradores de páginas de referencia de la API** y, a continuación, elija la página de punto de conexión REST del producto para finalizar el contenido de la página.

1. Elija **Editar página**.

1. Para invalidar la documentación existente de API Gateway, en **Origen de documentación**, active **Invalidar la documentación** y haga lo siguiente:

   1. Para **Mostrar contenido**, elija **Crear invalidación**.

   1. Para **Nombre de operación**, ingrese un nombre de operación nuevo. 

   1. Para **Cuerpo de página**, ingrese la documentación personalizada.

   1. (Opcional) Para **Punto de conexión**, ingrese un punto de conexión personalizado que aparezca en el portal.

1. Para permitir que los clientes invoquen la API en el portal, seleccione la **funcionalidad de la prueba**. Para obtener más información, consulte [Habilitación de una prueba para un punto de conexión REST de un producto de API Gateway en el portal](apigateway-portals-try-it.md).

1. Para **Nombre de sección**, ingrese un nombre o elija una sección existente. Al agregar el punto de conexión REST del producto a una sección, los consumidores pueden ver el contenido en un portal publicado.

1. Seleccione **Save changes (Guardar cambios)**.

Para que los consumidores puedan ver la nueva página, igual tendrá que volver a publicar el portal. Para obtener más información, consulte [Publicación de un portal en API Gateway](apigateway-portals-publish-portal.md). 

# Creación de una página de producto en API Gateway
<a name="apigateway-portals-create-product-page"></a>

Una página del producto ayuda a los consumidores de los productos a entender y utilizar los productos. La documentación se encuentra por producto, por lo que todos los portales que incluyan el producto disponen de esta documentación. API Gateway admite dos tipos de páginas de productos escritas en [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax):

Página de información general  
Al crear el producto, API Gateway genera automáticamente una página de **Información general** del producto en función de la información que proporciona al crear el producto. Esta página tiene un formato adicional que no se puede cambiar. Puede modificar el texto o eliminar la página del producto del portal.

Páginas personalizadas  
Una página personalizada es una página escrita en Markdown. Puede usar esta sección para ver los términos y condiciones o un tutorial sobre cómo usar el producto. Puede convertir cualquier página personalizada en una página de información general. Al convertir una página personalizada en una página de información general, el contenido de la página tiene un formato que coincide con el de la página de información general.

## Consideraciones
<a name="apigateway-portals-create-product-page-considerations"></a>

Las siguientes consideraciones pueden afectar al uso de las páginas de productos:
+ Esta documentación no se encuentra por API y no incluye ningún método, recurso ni parámetro de solicitud. Para obtener información sobre cómo modificar la documentación por API de un producto, consulte [Actualización de un punto de conexión REST del producto en API Gateway](apigateway-portals-update-product-endpoint.md).
+ No puede cargar un archivo `.md` directamente en el producto.
+ Puede modificar el orden de las páginas de productos modificando la lista de páginas en el orden de visualización del producto del portal. Para obtener más información, consulte [Actualización de un producto del portal en API Gateway](apigateway-portals-update-portal-product.md).
+ Debe volver a publicar todos los portales que incluyan el producto para que los cambios en la documentación surtan efecto.
+ Si tiene varios portales que utilizan el mismo producto del portal, las páginas del producto son las mismas en todos los portales. Para tener los mismos puntos de conexión REST del producto pero diferentes páginas de productos, cree varios productos.

## Creación de una página de producto
<a name="apigateway-portals-create-product-page-create"></a>

El siguiente procedimiento muestra cómo crear una página de producto.

**Creación de una página de producto**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. En el panel de navegación principal, elija **Productos de portales**.

1. Elija un producto.

1. En **Documentación**, elija **Crear página personalizada**.

1. Para **Título de la página**, ingrese el título de la página. 

1. Para **Cuerpo**, ingrese la documentación complementaria mediante GitHub Flavored Markdown.

   La sección de **vista previa** muestra cómo aparece el contenido en un portal. El estilo visual final puede cambiar en función de la configuración del portal.

1. Elija **Crear página del producto**.

1. La página del producto es ahora un borrador. Elija **Borradores de páginas de documentación** y, a continuación, elija la página del producto para finalizar el contenido de la página.

1. Elija **Editar página**.

1. Para **Nombre de sección**, ingrese un nombre o elija una sección existente. Al agregar la página del producto a una sección, los consumidores pueden ver el contenido en un portal publicado.

1. Seleccione **Save changes (Guardar cambios)**.

Para que los consumidores puedan ver la nueva página, igual tendrá que volver a publicar el portal. Para obtener más información, consulte [Publicación de un portal en API Gateway](apigateway-portals-publish-portal.md). 

# Actualización de un producto del portal en API Gateway
<a name="apigateway-portals-update-portal-product"></a>

Al actualizar un producto del portal, puede cambiar el nombre, la descripción o el orden de visualización de cómo aparecen los puntos de conexión REST del producto y las páginas de productos. Para modificar el orden de visualización, modifique la lista de páginas para las páginas de productos y el nombre de la sección para los puntos de conexión de los productos. Si lo hace mediante la AWS CLI o los SDK, especifique el ARN de la página del producto o el ARN del punto de conexión REST del producto. Debe volver a publicar todos los portales que utilicen los productos para que los consumidores de la API puedan ver los cambios reflejados en un portal.

## Actualización de un producto del portal
<a name="apigateway-portals-update-portal-product-update"></a>

En el siguiente procedimiento se muestra cómo cambiar la lista de secciones para reordenar los puntos de conexión REST del producto tal como aparecerán en un portal. En este procedimiento, asumimos que tiene al menos dos puntos de conexión REST de producto en el producto del portal.

**Actualización de un producto del portal**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. En el panel de navegación principal, elija **Productos de portales**.

1. Elija un producto.

1. En la pestaña **Documentación**, en las **páginas de productos**, elija **Administrar**.

1. Arrastre y suelte los puntos de conexión REST del producto para reordenarlos. También puede mover los puntos de conexión REST del producto y las páginas del producto a la sección de borradores de páginas. Las páginas del borrador de las páginas no estarán visibles en el portal.

1. (Opcional) Cambie el nombre de los puntos de conexión REST del producto o agregue una nueva sección de referencia de la API. Estos cambios no afectarán a las API de REST.

1. Seleccione **Save changes (Guardar cambios)**.

# Actualización de un punto de conexión REST del producto en API Gateway
<a name="apigateway-portals-update-product-endpoint"></a>

Al actualizar un punto de conexión REST de un producto, puede cambiar todos los ajustes del punto de conexión del producto, excepto la ruta y el método de una API de REST y la fase en la que se implementa. Todos los cambios en los puntos de conexión de los productos se actualizan automáticamente, pero debe volver a publicar todos los portales que utilicen los productos para ver los cambios reflejados en un portal.

## Actualización de un punto de conexión REST del producto
<a name="apigateway-portals-update-product-endpoint-update"></a>

El siguiente procedimiento muestra cómo actualizar un punto de conexión REST del producto para sobrescribir la documentación de la API actual con una documentación de referencia de la API personalizada.

**Actualización de un punto de conexión REST del producto**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. En el panel de navegación principal, elija **Productos de portales**.

1. Elija un producto.

1. En la pestaña **Documentación**, en las **páginas de referencia de la API**, elija el nombre del punto de conexión REST de un producto, como **/dogs - GET**.

1. Para **Vista previa**, elija **Editar página**.

1. Para **Origen de la documentación**, active **Invalidación de la documentación**.

1. En **Mostrar contenido**, elija **Invalidación del contenido existente**.

   Si elige **Eliminar todo el contenido**, el contenido se elimina de la página, pero puede elegir **Invalidar el contenido existente** para volver a acceder a la documentación.

1. En el **cuerpo de la página**, ingrese la documentación de referencia de la API personalizada mediante [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).

   Esta documentación no se volverá a propagar a API Gateway.

1. Seleccione **Save changes (Guardar cambios)**.

1. Para que los cambios surtan efecto, es necesario volver a publicar cualquier portal que utilice este producto de portal.

# Actualización de una página de producto en API Gateway
<a name="apigateway-portals-update-product-page"></a>

Cuando actualice la página de un producto, puede cambiar todos los ajustes de la página del producto. Todos los cambios en la página del producto se actualizan automáticamente, pero debe volver a publicar todos los portales que utilicen los productos para ver los cambios reflejados en un portal.

# Uso compartido de productos de portal en API Gateway
<a name="apigateway-portals-share-resources"></a>

Puede compartir un producto del portal a través de Cuentas de AWS mediante AWS RAM. Cuando comparte un producto del portal, la otra cuenta puede usar el producto del portal en su propio portal. Con los productos del portal compartidos, puede crear un catálogo único de las API de la organización y hacer cumplir los estándares de gobernanza en todo su ecosistema de API. Al mismo tiempo, compartir los productos del portal proporciona flexibilidad a los proveedores de la API para desarrollar, probar y mantener las API en sus propias cuentas.

## Consideraciones
<a name="apigateway-portals-share-resources-considerations"></a>

Las siguientes consideraciones pueden afectar a cómo comparte los recursos del portal:
+ Cuando comparte el producto con otra cuenta, esa cuenta no puede modificar ninguna propiedad de la API de REST. Esto incluye los puntos de conexión de la integración, la estrategia de autorización o la configuración de las etapas.
+ Cuando agrega el producto del portal de otra cuenta al portal, el propietario del producto del portal no puede ver ni controlar ninguna otra propiedad del portal. El propietario del producto del portal solo sabe que el producto se está utilizando en el portal.
+ Los productos del portal de API Gateway se comparten por Región de AWS.
+ Puede usar un recurso compartido con varias entidades principales y, una vez creado el recurso compartido, puede agregarle más entidades principales. Le recomendamos que reutilice el recurso compartido siempre que sea posible.
+ Si ambas cuentas pertenecen a la misma organización que utiliza AWS Organizations, el recurso compartido se acepta automáticamente. Aún en este caso debe crear el recurso compartido mediante AWS RAM.
+ Si ambas cuentas pertenecen a la misma organización que utiliza AWS Organizations y la organización tiene habilitado el uso compartido de recursos, se concederá automáticamente acceso a los recursos compartidos a todas las entidades principales de la organización con las que comparte. No se precisa invitación y puede omitir el uso compartido de recursos.
+ Si la cuenta con la que compartió el producto no acepta el recurso compartido en un plazo de **12 horas**, debe volver a compartir el recurso.
+ Tras crear el recurso compartido, AWS RAM actualiza la política de uso compartido de productos del producto para impedir el acceso a las entidades principales que no dispongan de un acceso `allow` explícito. Para obtener más información, consulte [Cómo determinar si una solicitud se permite o se deniega dentro de una cuenta](https://docs.aws.amazon.com//IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow) en la Guía del usuario de IAM.

  La política de recursos actualizada será similar a lo siguiente:

  ```
  {
      "Version": "2012-10-17",		 	 	 
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "apigateway:GetProduct",
                  "apigateway:ListEndpoints",
                  "apigateway:ListPages",
                  "apigateway:GetEndpoint",
                  "apigateway:GetPage"
              ],
              "Resource": [
                  "arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id",
                  "arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id/*"
              ]
          }
      ]
  }
  ```

  AWS RAM ha impedido que las entidades principales sin acceso allow explícito agreguen su producto a su portal al agregar lo siguiente:

  ```
  "StringNotEquals": { "aws:PrincipalAccount": "555555555555" }
  ```

Para obtener información sobre cómo compartir un producto, consulte [Compartir el producto del portal con el propietario del portal en API Gateway](apigateway-portals-share-products.md). Para obtener información sobre cómo agregar al portal un producto compartido con usted, consulte [Agregación de un producto del portal compartido al portal en API Gateway](apigateway-portals-use-shared-products.md).

# Compartir el producto del portal con el propietario del portal en API Gateway
<a name="apigateway-portals-share-products"></a>

Como propietario de un producto, puede compartir el producto con el propietario del portal en otra Cuenta de AWS mediante AWS RAM. Se mantiene el control total de todas las páginas de productos y de las páginas de punto de conexión REST de los productos.

## Consideraciones
<a name="apigateway-portals-share-products-considerations"></a>

Las siguientes consideraciones pueden afectar a cómo comparte los productos del portal:
+ Puede compartir o dejar de compartir los productos del portal en cualquier momento. Si deja de compartir un producto del portal mientras se está utilizando en un portal publicado, el propietario del portal no podrá ver el producto del portal, ver las actualizaciones que se le hayan realizado ni volver a publicar ni obtener una vista previa del portal hasta que elimine el producto del portal.
+ Puede ver los productos del portal que ha compartido con otras cuentas.
+ No puede modificar ningún portal que contenga el producto del portal, a menos que cree el portal usted mismo.

## Uso compartido del producto del portal
<a name="apigateway-portals-share-products-share"></a>

El procedimiento siguiente muestra cómo crear un recurso compartido.

------
#### [ Consola de administración de AWS ]

Para usar la Consola de administración de AWS, consulte [Creación de un recurso compartido en AWS RAM](https://docs.aws.amazon.com/ram/latest/userguide/working-with-sharing-create.html) en la *Guía del usuario de AWS RAM*.

En **Seleccionar tipo de recurso**, elija **Producto de API Gateway**.

------
#### [ AWS CLI ]

El siguiente comando [create-resource-share](https://docs.aws.amazon.com/cli/latest/reference/ram/create-resource-share.html) permite crear un recurso compartido para el nombre de dominio personalizado privado. La asociación del recurso y la entidad principal puede tardar unos minutos en completarse. Para las entidades principales, proporcione un ID de cuenta o un ID de Organizations, como `arn:aws:organizations::123456789012:organization/o-1234abcd`. Puede proporcionar varias entidades principales para el recurso compartido.

```
aws ram create-resource-share \ 
 --region us-west-2 \ 
 --name portal-product-resource-share \ 
 --permission-arns arn:aws:ram::aws:permission/AWSRAMDefaultPermissionAPIGatewayDeveloperPortalProduct \ 
 --resource-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \ 
 --principals 222222222222
```

------

Para dejar de compartir el producto del portal, utilice AWS RAM para eliminar el recurso compartido.

En cualquier momento, puede modificar la política de uso compartido de productos para modificar qué entidades principales pueden utilizar los productos del portal en sus portales.

**Actualización de la política de uso compartido de productos**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. En el panel de navegación principal, elija **Productos de portales**.

1. Elija un producto.

1. En la pestaña **Uso compartido de productos**, en **Política de uso compartido de productos**, elija **Administración de política de uso compartido de productos**.

1. Si no ha compartido el producto anteriormente, la política de uso compartido de productos denegará el acceso de otras cuentas a los productos del portal. Debe actualizar la política para permitir el acceso de determinadas cuentas al producto del portal.

1. Tras actualizar la política de uso compartido de productos, elija **Guardar cambios**.

# Agregación de un producto del portal compartido al portal en API Gateway
<a name="apigateway-portals-use-shared-products"></a>

Como propietario del portal, puede usar productos del portal compartidos con usted por otras cuentas en el portal. Mantenga pleno control del portal.

## Consideraciones
<a name="apigateway-portals-use-shared-products-considerations"></a>

Las siguientes consideraciones pueden afectar a cómo comparte los recursos del portal:
+ Debe aceptar el recurso compartido del producto del propietario del producto para poder utilizar el producto en el portal. Si el propietario del producto y usted están en la misma organización, AWS RAM puede completar algunos pasos compartidos para usted.
+ Si el propietario del producto deja de compartir un producto mientras está en el portal publicado, el producto seguirá visible en el portal, pero no podrá volver a publicar el portal hasta que lo elimine. Como propietario del portal, es su responsabilidad eliminar el producto del portal, ya que el propietario del producto no puede hacerlo por usted.
+ Puede ver los productos del portal, las páginas de productos y las páginas de punto de conexión REST del producto, pero no puede modificar ninguno de estos recursos.
+ Si se comparte un producto con usted, no podrá compartirlo con otra cuenta.

## (Opcional) Aceptación del recurso compartido
<a name="apigateway-portals-use-shared-products-accept"></a>

Después de que el propietario del producto cree un recurso compartido, dispone de **12 horas** para aceptarlo. Si pertenece a la misma organización que utiliza AWS Organizations como el propietario del producto, el recurso compartido se acepta automáticamente. Si pertenece a una organización que tiene habilitados los recursos compartidos automáticos, el recurso se comparte automáticamente con usted.

------
#### [ Consola de administración de AWS ]

Para usar la Consola de administración de AWS, consulte [Aceptar y rechazar invitaciones a recursos compartidos](https://docs.aws.amazon.com/ram/latest/userguide/working-with-shared-invitations.html) en la *Guía del usuario de AWS RAM*. 

------
#### [ AWS CLI ]

Para buscar todos los recursos que se comparten con usted, utilice el siguiente comando [get-resource-share-invitations](https://docs.aws.amazon.com/cli/latest/reference/ram/get-resource-share-invitations.html):

```
aws ram get-resource-share-invitations \
    --region us-west-2
```

Utilice el ARN del recurso compartido resultante para aceptar la invitación al recurso compartido. El siguiente comando [accept-resource-share-invitation](https://docs.aws.amazon.com/cli/latest/reference/ram/accept-resource-share-invitation.html) permite aceptar el recurso compartido.

```
aws ram accept-resource-share-invitation \
    --resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE \
    --region us-west-2
```

------

## Agregación de un producto compartido en el portal
<a name="apigateway-portals-use-shared-products-add"></a>

Tras aceptar el recurso compartido, agregue el producto al portal.

------
#### [ Consola de administración de AWS ]

**Agregación de un producto compartido al portal**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. En el panel de navegación principal, elija **Portales**.

1. Elija un portal.

1. En la pestaña **Productos**, para los **productos del portal**, elija **Agregar productos**.

1. Agregue un producto al portal. Los productos compartidos se muestran como `shared` en la lista de productos.

1. Seleccione **Save changes (Guardar cambios)**.

------
#### [ AWS CLI ]

Para encontrar todos los productos del portal que se han compartido con usted, utilice el comando `get-portal-products` siguiente:

```
aws apigatewayv2 get-portal-products \
    --resource-owner OTHER_ACCOUNTS \
    --region us-west-2
```

Para agregar un producto de portal compartido al portal, utilice el comando `update-portal` siguiente:

```
aws apigateway update-portal \
    --included-portal-product-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \
    --region us-west-2
```

------

# Habilitación de una prueba para un punto de conexión REST de un producto de API Gateway en el portal
<a name="apigateway-portals-try-it"></a>

Use la prueba para permitir que un consumidor de API invoque el punto de conexión del producto desde el portal. Cuando un consumidor de la API utiliza la prueba, ingresa los parámetros de solicitud del método e invoca el punto de conexión del producto. A continuación, API Gateway invoca la API a través de Internet pública y devuelve la respuesta en la ventana de la prueba. Puede usar una página de producto personalizada para proporcionar cualquier información adicional sobre los parámetros necesarios para acceder a la API.

API Gateway utiliza los siguientes límites para proteger las API:
+ API Gateway solo permite 3 solicitudes por segundo a la API.
+ API Gateway utiliza un límite de tiempo de espera integrado de 29 000 ms. Es posible que la API actual tenga un límite de tiempo de espera más alto, pero API Gateway no aplica este tiempo de espera cuando un cliente usa la prueba.
+ API Gateway limita la carga útil de respuesta a 6 MB.

## Consideraciones
<a name="apigateway-portals-try-it-considerations"></a>

Las siguientes consideraciones pueden afectar a cómo usar la prueba:
+ La prueba no es compatible con la vista previa de un portal.
+ La prueba no es compatible para las API de REST con las siguientes características:
  + API privadas
  + API que utilizan TLS mutuo
  + API que utilizan certificados SSL privados o autofirmados

  Como propietario del portal, es responsable de la comunicación con los consumidores de la API. El motivo por el que usar el botón de prueba no existe para ninguna API de REST que no sea compatible. API Gateway no le explica esto.

## Habilitación de la prueba para un punto de conexión REST de un producto
<a name="apigateway-portals-try-it-procedure"></a>

En el siguiente procedimiento, se muestra cómo habilitar la prueba para un punto de conexión de producto.

Para obtener información sobre cómo utilizar la prueba en un portal, consulte [Uso de un portal de API Gateway](apigateway-portals-use-portal.md).

**Habilitación de la prueba para un punto de conexión REST de un producto**

1. En el panel de navegación principal, elija **Productos de portales**.

1. Elija un producto.

1. En la pestaña **Documentación**, en las **páginas de referencia de la API**, elija el nombre del punto de conexión REST de un producto, como **/dogs - GET**.

1. Elija **Editar página**.

1. Para permitir que los clientes invoquen la API en el portal, seleccione la **funcionalidad de la prueba**.

1. Seleccione **Save changes (Guardar cambios)**.

1. Para que los cambios surtan efecto, es necesario volver a publicar cualquier portal que utilice este producto de portal.

# Eliminación de un producto del portal en API Gateway
<a name="apigateway-portals-delete-product"></a>

Al eliminar un producto del portal, no pude recuperarse.

## Eliminación de un producto del portal
<a name="apigateway-portals-delete-product-delete"></a>

El procedimiento siguiente muestra cómo eliminar un producto del portal.

**Eliminación de un producto del portal**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. En el panel de navegación principal, elija **Productos de portales**.

1. Elija un producto del portal.

1. Elija **Eliminar**.

1. Confirme la elección y elija **Eliminar**.

1. Para que los cambios surtan efecto, es necesario volver a publicar cualquier portal que utilice este producto de portal.