Erstellen Sie ein Portal in API Gateway - Amazon API Gateway
Wählen Sie einen DomainnamenErstellen Sie ein Portal

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Erstellen Sie ein Portal in API Gateway

Ein Portal ist eine Sammlung von Produkten. Sie kontrollieren die Autorisierung, das Branding und die Veröffentlichung Ihres Portals. Wenn Sie ein Portal erstellen, lautet der VeröffentlichungsstatusDisabled. Das bedeutet, dass Ihr Portal im Internet nicht auffindbar ist. Damit Verbraucher auf Ihr Portal zugreifen können, müssen Sie es veröffentlichen. Bevor Sie Ihr Portal veröffentlichen, können Sie es auch in der Vorschau anzeigen.

API Gateway unterstützt Portale in den folgenden Browsern:

  • Firefox

  • Google Chrome

  • Microsoft Edge

  • Safari

Wählen Sie einen Domainnamen

Standardmäßig wird Ihre Portal-URL unter dem folgenden Domainnamen gehostet, der Amazon gehört:

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

Um den Domainnamen anzupassen, können Sie einen Domainnamen, den Sie besitzen, und ein SSL-Zertifikat für die benutzerdefinierte Domain angeben. Das Zertifikat muss mit AWS Certificate Manager(ACM) in USA Ost (Nord-Virginia) verwaltet und von Amazon CloudFront unterstützt werden. Weitere Informationen finden Sie unter Anforderungen für die Verwendung von SSL/TLS Zertifikaten mit CloudFront.

Wenn Sie einen benutzerdefinierten Domainnamen verwenden, erstellt API Gateway eine CloudFront Distribution, die während der Übertragung mit Ihrem ACM-Zertifikat gesichert ist. Anschließend stellt API Gateway einen Aliaseintrag bereit, den Sie zu Ihrer DNS-Konfiguration hinzufügen. Der Aliaseintrag ist der Domainname, der Amazon gehört. Sie müssen diesen Aliaseintrag hinzufügen, um Traffic an die CloudFront Distribution für Ihre benutzerdefinierte Domain weiterzuleiten. Der von Ihnen angegebene Domainname muss eindeutig sein und darf nicht bereits in der Aliasliste einer bestehenden CloudFront Distribution verwendet werden.

Wenn Sie Ihren eigenen Domainnamen verwenden, verwendet API Gateway die TLS_1_2 Sicherheitsrichtlinie, um Ihr Portal zu schützen. Weitere Informationen finden Sie unter Unterstützte Protokolle und Chiffren zwischen Zuschauern. Sie können diesen Wert nicht ändern.

Erstellen Sie ein Portal

Sie verwenden die API Gateway Gateway-Konsole, um Ihr Portal zu erstellen und zu konfigurieren. Die folgenden Verfahren führen Sie durch alle erforderlichen Schritte. Sie können am Ende des ersten Verfahrens auch „Zur Überprüfung überspringen“ und „Erstellen“ wählen, um ein leeres Portal zu erstellen.

Das folgende Verfahren zeigt, wie Sie ein Portal erstellen. Zunächst definieren Sie Ihre Portaldetails.

Um Ihre Portaldetails zu definieren

  1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

  2. Wählen Sie im Hauptnavigationsbereich Portals aus.

  3. Wählen Sie Create Portal (Portal erstellen) aus.

  4. Geben Sie unter Portaldetails für Portalname einen Namen ein.

  5. Geben Sie unter Portalbeschreibung eine Beschreibung ein.

  6. Wählen Sie für die Portalautorisierung aus, wie Sie Ihr Portal autorisieren möchten.

    • Wenn Sie zum ersten Mal ein Portal erstellen, empfehlen wir Ihnen, None zu wählen. Wenn Sie Ihrem Portal eine Produktion APIs hinzufügen möchten, verwenden Sie die Option Autorisierung erforderlich.

    • Wenn Sie festlegen möchten, dass sich Portalnutzer für die Nutzung Ihres Portals authentifizieren müssen, wählen Sie Autorisierung erforderlich aus und gehen Sie wie folgt vor:

      1. Wählen Sie für den Amazon Cognito Cognito-Benutzerpool Ihren Benutzerpool aus.

        Der Benutzerpool muss sich in derselben Region wie Ihr Portal befinden.

      2. Wählen Sie für Anwendungsclient-ID die App-Client-ID aus.

        In Ihrem App-Client müssen Sie die Callback-URL auf die Standard-URL des Portals festlegen.

      3. Geben Sie für Benutzerpool-Domäne die Benutzerpool-Domäne ein. Weitere Informationen finden Sie unter Konfiguration einer Benutzerpool-Domäne.

  7. Wählen Sie für die Domänenkonfiguration den Domainnamen für Ihr Portal aus.

    • Wenn Sie zum ersten Mal ein Portal erstellen, empfehlen wir Ihnen, Standarddomäne zu wählen. Sobald Sie Ihr Portal veröffentlicht haben, ist es unter verfügbarhttps://p-portalId.apigw-portal.us-east-1.on.aws.

    • Um einen benutzerdefinierten Domainnamen anzugeben, den Sie besitzen, wählen Sie Benutzerdefinierter Domainname aus und gehen Sie wie folgt vor:

      1. Geben Sie unter Domainname einen vollqualifizierten Domainnamen ein.

      2. Wählen Sie für ein ACM-Zertifikat ein ACM-Zertifikat aus, das den Domainnamen abdeckt.

        Sie müssen den Aliaseintrag, den API Gateway bereitstellt, zu Ihrem DNS-Eintrag hinzufügen, um Traffic von Ihrem Portal aus bereitzustellen.

  8. Um Ihrem Portal einen CloudWatch RUM-App-Monitor hinzuzufügen, wählen Sie für RUM-App-Monitor einen App-Monitor aus. Weitere Informationen finden Sie unter CloudWatch RUM.

  9. Wählen Sie Weiter aus.

Nachdem Sie Ihre Portaldetails definiert haben, fügen Sie Portalprodukte hinzu. Sie können die Portalprodukte in Ihrem Portal jederzeit ändern, müssen Ihr Portal jedoch erneut veröffentlichen, damit die Änderungen wirksam werden.

Um Ihre Portalprodukte auszuwählen

  1. Wählen Sie aus der Ressourcenliste die Produkte aus, die Sie Ihrem Portal hinzufügen möchten.

  2. Wählen Sie Weiter aus.

Nachdem Sie Ihre Produkte ausgewählt haben, passen Sie das Portaldesign an. Um ein Portal-Logo hochzuladen, müssen Sie ein Bild auf Amazon S3 hochgeladen haben. Sie können diese Werte jederzeit ändern, müssen Ihr Portal jedoch erneut veröffentlichen, damit die Änderungen wirksam werden.

(Optional) Um Ihr Portal anzupassen

  1. Geben Sie für das Portal-Logo den S3-URI für Ihre Datei an.

    Nur .svg.png, oder .jpg werden unterstützt.

  2. Um das Design Ihres Portals anzupassen, haben Sie zwei Möglichkeiten:

    1. Sie können das Portaldesign auswählen, um ein vorgefertigtes Farbdesign auf Ihr Portal anzuwenden.

    2. Sie können die Farbauswahlmöglichkeiten verwenden, um alle Ihre Portal-Designoptionen auszuwählen.

  3. Wählen Sie Weiter aus.

Nachdem Sie das Portaldesign ausgewählt haben, überprüfen Sie die Informationen für das Portal.

Um Ihr Portal zu überprüfen

  • Überprüfen Sie Ihre Einstellungen auf der Seite „Überprüfen und erstellen“. Wenn Sie mit den Einstellungen zufrieden sind, klicken Sie auf Create (Erstellen).

Wenn Sie einen Amazon Cognito Cognito-Benutzerpool verwenden, um den Zugriff auf Ihr Portal zu steuern, müssen Sie die Callback-URL im App-Client auf die Standard-URL des Portals festlegen. Weitere Informationen finden Sie unter Anwendungsspezifische Einstellungen mit App-Clients.

Ihr Portal steht Verbrauchern nicht mehr zur Verfügung, nachdem Sie es erstellt haben. Sie müssen Ihr Portal veröffentlichen, damit es im Internet zugänglich ist. Weitere Informationen finden Sie unter Veröffentlichen Sie ein Portal in API Gateway.