API Gateway でポータルを作成する - Amazon API Gateway

API Gateway でポータルを作成する

ポータルは製品のコレクションです。ポータルの承認、ブランド化、公開はユーザーが管理します。ポータルを作成すると、公開ステータスは Disabled になります。つまり、ポータルはウェブ上で検出できません。コンシューマーがポータルにアクセスできるようにするには、ポータルを公開する必要があります。ポータルを公開する前に、プレビューすることもできます。

API Gateway は、次のブラウザでポータルをサポートしています。

  • Firefox

  • Google Chrome

  • Microsoft Edge

  • Safari

ドメイン名を選択する

デフォルトでは、ポータル URL は次の Amazon 所有ドメイン名でホストされます。

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

ドメイン名をカスタマイズするには、所有するドメイン名とカスタムドメインの SSL 証明書を指定します。証明書は、米国東部 (バージニア北部) の AWS Certificate Manager (ACM) で管理され、Amazon CloudFront でサポートされる必要があります。詳細については、「CloudFront で SSL/TLS 証明書を使用するための要件」を参照してください。

カスタムドメイン名を使用すると、API Gateway は ACM 証明書で転送中に保護される CloudFront ディストリビューションを作成します。次に、API Gateway は DNS 設定に追加するエイリアスレコードを提供します。エイリアスレコードは Amazon 所有のドメイン名です。このエイリアスレコードを追加して、カスタムドメインの CloudFront ディストリビューションにトラフィックを送信する必要があります。指定するドメイン名は一意で、既存の CloudFront ディストリビューションのエイリアスリストでまだ使用されていない必要があります。

独自のドメイン名を使用する場合、API Gateway は TLS_1_2 セキュリティポリシーを使用してポータルを保護します。詳細については、「ビューワーとの間でサポートされているプロトコルと暗号」を参照してください。この値を変更することはできません。

ポータルを作成する

API Gateway コンソールを使用して、ポータルを作成および設定します。次の手順では、必要なすべての手順について説明します。最初の手順の最後に [スキップして確認および作成] を選択して、空のポータルを作成することもできます。

次の手順で、ポータルを作成する方法を示します。まず、ポータルの詳細を定義します。

ポータルの詳細を定義するには
  1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

  2. メインナビゲーションペインで、[ポータル] を選択します。

  3. [ポータルの作成] を選択します。

  4. ポータルの詳細の [ポータル名] に名前を入力します。

  5. [ポータルの説明] に、説明を入力します。

  6. [ポータル認証] では、ポータルを承認する方法を選択します。

    • ポータルを初めて作成する場合は、[なし] を選択することをお勧めします。ポータルに本番稼働用 API を追加する予定がある場合は、[認可が必要] を使用します。

    • ポータルを使用するための認証をポータルコンシューマーに要求するには、[認可が必要] を選択し、以下を実行します。

      1. [Amazon Cognito ユーザープール] で、ユーザープールを選択します。

        ユーザープールは、ポータルと同じリージョンに存在する必要があります。

      2. [アプリケーションクライアント ID] で、アプリケーションクライアント ID を選択します。

        アプリケーションクライアントでは、コールバック URL をポータルのデフォルト URL に設定する必要があります。

      3. [ユーザープールドメイン] には、ユーザープールドメインを入力します。詳細については、「ユーザープールのドメインの設定」を参照してください。

  7. [ドメイン設定] で、ポータルのドメイン名を選択します。

    • ポータルを初めて作成する場合は、[デフォルトドメイン] を選択することをお勧めします。ポータルを公開すると、https://p-portalId.apigw-portal.us-east-1.on.aws で利用可能になります。

    • 所有しているカスタムドメイン名を指定するには、[カスタムドメイン名] を選択し、以下を実行します。

      1. [ドメイン名] に完全修飾ドメイン名を入力します。

      2. [ACM 証明書] の場合は、ドメイン名をカバーする ACM 証明書を選択します。

        ポータルからのトラフィックを処理するには、API Gateway がプロビジョニングするエイリアスレコードを DNS レコードに追加する必要があります。

  8. CloudWatch RUM アプリモニターをポータルに追加するには、[RUM アプリケーションモニター] でアプリケーションモニターを選択します。詳細については、「CloudWatch RUM」を参照してください。

  9. [次へ] を選択します。

ポータルの詳細を定義したら、ポータル製品を追加します。ポータルのポータル製品はいつでも変更できますが、変更を有効にするにはポータルを再公開する必要があります。

ポータル製品を選択するには
  1. リソースリストから、ポータルに追加する製品を選択します。

  2. [次へ] を選択します。

製品を選択したら、ポータルデザインをカスタマイズします。ポータルロゴをアップロードするには、Amazon S3 にアップロードされたイメージが必要です。これらの値はいつでも変更できますが、変更を有効にするにはポータルを再公開する必要があります。

(オプション) ポータルをカスタマイズするには
  1. [ポータルロゴ] には、ファイルの S3 URI を指定します。

    .svg.png、または .jpg のみがサポートされています。

  2. ポータルのデザインをカスタマイズするには、次の 2 つのオプションがあります。

    1. [ポータルテーマ] を選択して、事前に作成されたカラーテーマをポータルに適用できます。

    2. カラーセレクタを使用して、すべてのポータルデザインオプションを選択できます。

  3. [次へ] を選択します。

ポータルデザインを選択したら、ポータルの情報を確認します。

ポータルを確認するには
  • [確認および作成] ページで設定を確認します。設定が適切であることを確認したら、[Create] (作成) を選択します。

Amazon Cognito ユーザープールを使用してポータルへのアクセスを制御する場合は、コールバック URL をアプリケーションクライアントのポータルのデフォルト URL に設定する必要があります。詳細については、「アプリケーションクライアントによるアプリケーション固有の設定」を参照してください。

ポータルは、作成後はコンシューマーが使用できなくなります。インターネットでアクセスできるようにするには、ポータルを公開する必要があります。詳細については、「API Gateway でポータルを公開する」を参照してください。