

# 在 API Gateway 中创建门户
<a name="apigateway-portals-create-portal"></a>

门户是产品的集合。您可以控制门户网站的授权、品牌和发布。创建门户时，其发布状态为 `Disabled`。这意味着您的门户无法在 Web 上被发现。要让消费者访问您的门户，您需要发布门户。在发布门户之前，您也可以预览门户。

API Gateway 支持以下浏览器上的门户：
+ Firefox
+ Google Chrome
+ Microsoft Edge
+ Safari

## 选择域名
<a name="apigateway-portals-create-portal-domain-name"></a>

默认情况下，您的门户 URL 托管在 Amazon 拥有的以下域名中：

```
https://p-{{portalId}}.apigw-portal.{{us-east-1}}.on.aws
```

要自定义域名，您可以提供自己拥有的域名和自定义域的 SSL 证书。该证书必须通过美国东部（弗吉尼亚州北部）的 [Amazon Certificate Manager](https://docs.amazonaws.cn/acm/latest/userguide/)（ACM）进行管理，且需获得 Amazon CloudFront 的支持。有关更多信息，请参阅[在 CloudFront 中使用 SSL/TLS 证书的要求](https://docs.amazonaws.cn/AmazonCloudFront/latest/DeveloperGuide/cnames-and-https-requirements.html)。

使用自定义域名时，API Gateway 会创建一个 CloudFront 分配，通过您的 ACM 证书保障传输中安全。之后，API Gateway 会提供一个别名记录，您需将该记录添加到您的 DNS 配置中。别名记录是 Amazon 拥有的域名。您必须添加此别名记录才能将流量引导至自定义域的 CloudFront 分配。您提供的域名必须是唯一的，尚未被现有 CloudFront 分配中的别名列表所使用。

如果您使用自己的域名，API Gateway 会使用 `TLS_1_2` 安全策略来保护您的门户。有关更多信息，请参阅[查看器之间支持的协议和密码](https://docs.amazonaws.cn/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html)。您不能更改此值。

## 创建门户
<a name="apigateway-portals-create-portal-create"></a>

可以使用 API Gateway 控制台创建和配置门户。以下过程将指导您完成所有所需步骤。您也可以在第一个步骤的末尾选择**跳过以检查并创建**，以创建一个空门户。

以下过程说明了如何创建门户。首先，定义您的门户详细信息。

**定义您的门户详细信息**

1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.amazonaws.cn/apigateway)。

1. 在主导航窗格中，选择**门户**。

1. 选择 **创建门户**。

1. 在门户详细信息下，对于**门户名称**，输入名称。

1. 对于**门户描述**，请输入描述。

1. 对于**门户授权**，请选择如何授权您的门户。
   + 如果这是您第一次创建门户，建议您选择**无**。如果您计划向门户添加任何生产 API，请使用**需要授权**。
   + 若要求门户使用者必须通过身份验证才能使用您的门户，请选择**需要授权**，然后执行以下操作：

     1. 对于 **Amazon Cognito 用户池**，请选择您的用户池。

        用户池必须位于您的门户所在的同一区域。

     1. 对于**应用程序客户端 ID**，选择应用程序客户端 ID。

        在应用程序客户端中，必须将回调 URL 设置为门户的默认 URL。

     1. 对于**用户池域**，输入用户池域。有关更多信息，请参阅[配置用户池域](https://docs.amazonaws.cn/cognito/latest/developerguide/cognito-user-pools-assign-domain.html)。

1. 对于**域配置**，选择门户的域名。
   + 如果这是您第一次创建门户，建议您选择**默认域**。发布门户后，它将在 `https://p-{{portalId}}.apigw-portal.{{us-east-1}}.on.aws` 上可用。
   + 要提供您拥有的自定义域名，请选择**自定义域名**并执行以下操作：

     1. 对于**域名**，输入您的完全限定域名。

     1. 对于 **ACM 证书**，请选择涵盖域名的 ACM 证书。

         为了使门户能够处理流量，您需要将 API Gateway 预调配的别名记录添加到您的 DNS 记录中。

1. 要将 CloudWatch RUM 应用程序监控器添加到您的门户，对于 **RUM 应用程序监控器**，请选择一个应用程序监视器。有关更多信息，请参阅 [CloudWatch RUM](https://docs.amazonaws.cn/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html)。

1. 选择**下一步**。

定义门户详细信息后，即可添加门户产品。您可以随时更改门户中的门户产品，但需要重新发布门户才能使更改生效。

**选择您的门户产品**

1. 从资源列表中，选择要添加到您的门户的产品。

1. 选择**下一步**。

选择产品后，您可以自定义门户设计。若要上传门户徽标，您必须将图像上传到 Amazon S3。您可以随时修改这些值，但需重新发布门户才能使更改生效。

**（可选）自定义门户**

1. 对于**门户徽标**，请提供文件的 S3 URI。

   仅支持 `.svg`、`.png` 或 `.jpg`。

1. 若要自定义门户的设计，您有两个选项：

   1. 您可以选择**门户主题**，为您的门户应用预设配色主题。

   1. 您可以使用颜色选择器来选择所有门户设计选项。

1. 选择**下一步**。

选择门户设计后，请检查门户的信息。

**检查门户**
+ 在“审核并创建”页面上，检查您的设置。如果对设置满意，请选择 **Create (创建)**。

如果您使用 Amazon Cognito 用户池来控制对门户的访问，则必须在应用程序客户端中将回调 URL 设置为门户的默认 URL。有关更多信息，请参阅[使用应用程序客户端进行应用程序特定设置](https://docs.amazonaws.cn/cognito/latest/developerguide/user-pool-settings-client-apps.html)。

创建门户后，消费者无法访问该门户。您必须发布门户，才能使其在互联网上可访问。有关更多信息，请参阅 [在 API Gateway 中发布门户](apigateway-portals-publish-portal.md)。