Domain personalisieren

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

Wenn Sie ein Entwicklerportal erstellen, wird für den Zugriff auf Ihr Liveportal standardmäßig ein Apigee-Beispieldomainname im folgenden Format bereitgestellt:

https://orgname-portalname.apigee.io

Dabei ist orgname der Organisationsname und portalname wird durch den Portalnamen definiert, wobei dieser in Kleinbuchstaben umgewandelt wird und Leerzeichen und Bindestriche entfernt werden.

Bevor Sie ein Entwicklerportal starten, sollten Sie Ihren eigenen Domainnamen angeben. Hier ist eine beliebte Alternative:

https://developers.example.com

Weitere Informationen zur Verwendung einer benutzerdefinierten Domain mit einem SAML-Identitätsanbieter finden Sie unter Benutzerdefinierte Domain mit SAML-Identitätsanbietern verwenden.

In den folgenden Abschnitten wird beschrieben, wie Sie Ihre Domain anpassen.

Domainnamen anpassen (Apigee Edge)

Führen Sie bei integrierten Portalen von Apigee Edge die folgenden Schritte aus, um Ihren Domainnamen anzupassen:

  1. Registrieren Sie den Domainname
  2. TLS konfigurieren
  3. Fügen Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzu.
  4. DNS konfigurieren.

Nachdem Sie eine benutzerdefinierte Domain hinzugefügt haben, können Sie sie bearbeiten oder deaktivieren. Informationen zur Fehlerbehebung finden Sie im Hilfeartikel Fehlerbehebung für benutzerdefinierte Domains.

Schritt 1: Ihren Domainnamen registrieren

Wenn Sie eine neue Domain registrieren müssen, können Sie eine Vielzahl von beliebten Websites zur Domainregistrierung nutzen, z. B. Google Domains. Sie entscheiden, welche Website Sie für die Domainregistrierung auswählen.

Wenn Sie sich für einen Domainnamen entscheiden, beachten Sie, dass nutzerfreundliche, für Menschen lesbare URLs wesentlich zur Suchmaschinenoptimierung beitragen, wie unter Suchmaschinenoptimierung (SEO) beschrieben.

Schritt 2: TLS konfigurieren

Zur Unterstützung von HTTPS müssen Sie TLS konfigurieren. Erstellen Sie dazu Schlüsselspeicher und Aliasse, die die erforderlichen digitalen Zertifikate in der Portalumgebung enthalten, wie im folgenden Verfahren beschrieben.

So konfigurieren Sie TLS:

  1. Kaufen Sie ein TLS-Zertifikat von einer vertrauenswürdigen Zertifizierungsstelle wie Google Trust Services. Welche Zertifizierungsstelle Sie auswählen, bleibt Ihnen überlassen.
  2. Melden Sie sich unter https://apigee.com/edge an.
  3. Wählen Sie im Menü Ihres Nutzerprofils Ihre Organisation aus.
  4. Wählen Sie Verwaltung > Umgebung > TLS-Schlüsselspeicher aus, um die Seite mit den TLS-Schlüsselspeichern aufzurufen.
  5. Wählen Sie Portal aus dem Drop-down-Menü für die Umgebung aus.

  6. Erstellen Sie einen Schlüsselspeicher und einen Alias, wie unter Schlüsselspeicher und Truststore mithilfe der Edge-Benutzeroberfläche erstellen beschrieben.

Schritt 3: Dem Portal einen benutzerdefinierten Domainnamen hinzufügen

Wenn Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzufügen, erstellt das System die folgenden Ressourcen für Sie. Dabei kommt dieselbe Funktionalität zum Einsatz, die beim Anwenden eines benutzerdefinierten Domainnamens auf einen Endpunkt wie api.example.com verwendet wird:

  • Ein virtueller Host, der Port 443 überwacht und den von Ihnen angegebenen benutzerdefinierten Domainnamen verwendet.

  • Einen API-Proxy, der die URL der benutzerdefinierten Domain verwendet, wobei der Zielendpunkt auf die Standarddomain des Portals festgelegt ist. Der Name des API-Proxys entspricht dem benutzerdefinierten Domainnamen, wobei die Punkte durch Unterstriche ersetzt werden. Der API-Proxy wird in der Portalumgebung bereitgestellt.

So fügen Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzu:

  1. Klicken Sie auf Veröffentlichen > Portale und wählen Sie Ihr Portal aus.
  2. Wählen Sie in der oberen Navigationsleiste oder auf der Landingpage im Drop-down-Menü die Option Einstellungen aus.
  3. Klicken Sie auf den Tab Domains.
  4. Füllen Sie unter Benutzerdefinierte Domain die folgenden Felder aus.
    Field Beschreibung
    Schlüsselspeicher Wählen Sie einen Schlüsselspeicher aus der Dropdown-Liste aus.

    Hinweis: Die Liste wird anhand der Schlüsselspeicher gefüllt, die Sie in Schritt 2 in der Portalumgebung erstellt haben.

    Nachdem Sie einen Schlüsselspeicher ausgewählt haben, wird das Feld Alias angezeigt.

    Alias Wählen Sie in der Drop-down-Liste einen gültigen Alias aus.

    Hinweis: Die Liste wird mit den Aliassen gefüllt, die Sie für den ausgewählten Schlüsselspeicher erstellt haben. Die Liste enthält keine Schlüsselspeicher mit ungültigen Zertifikatsketten, Apigee-Domains oder Truststores.

    So legen Sie fest, wann ein Zertifikat in der Liste abläuft:

    • Rufen Sie die Symbole auf:
      • Zertifikat ist gültig Das Zertifikat läuft in mehr als 30 Tagen ab oder die ausgewählte benutzerdefinierte Domain wird möglicherweise bereits verwendet.
      • Zertifikat läuft in 30 Tagen ab Das Zertifikat läuft in 30 Tagen ab.
      • Zertifikat ist abgelaufen Das Zertifikat ist abgelaufen.
    • Platzieren Sie den Mauszeiger auf einem Alias, um die verbleibende Anzahl von Tagen anzuzeigen, an denen das Zertifikat gültig ist.

    Nachdem Sie ein Alias ausgewählt haben, wird das Feld Domain angezeigt.

    Domain Wählen Sie eine Domain aus der Drop-down-Liste aus. Wenn Sie einen Platzhalteralias ausgewählt haben, geben Sie die Subdomain ein.

    Hinweis:In die Liste der Domains werden die allgemeinen und alternativen Namen für das Top-Level-Zertifikat in der Kette verwendet, die durch den ausgewählten Alias definiert ist.

    Nachdem Sie alle Felder ausgefüllt haben, wird das Statussymbol der benutzerdefinierten Domain so aktualisiert:
    Status Beschreibung
    Gültigkeitsstatus Schlüsselspeicher, Alias und benutzerdefinierte Domain sind gültig.
    Zertifikat läuft in 30 Tagen ab Das Zertifikat läuft in 30 Tagen ab.
    Status ungültig Schlüsselspeicher, Alias und benutzerdefinierte Domain sind ungültig.
    Außerdem wird die DNS-Konfiguration validiert und das Symbol „DNS-Status konfigurieren“ wird aktualisiert:
    Status Beschreibung
    Gültigkeitsstatus Die DNS-Konfiguration ist gültig.
    Status ungültig Die DNS-Konfiguration ist ungültig. Sie müssen Ihr DNS wie unter DNS konfigurieren beschrieben konfigurieren.
  5. Klicken Sie auf Aktivieren (oder auf Speichern, falls Sie es bearbeiten).
    Sie können Ihre benutzerdefinierte Domain auch dann aktivieren, wenn die benutzerdefinierte Domain oder DNS-Konfiguration ungültig ist.

Schritt 4: DNS konfigurieren

Als Nächstes müssen Sie dem DNS Ihrer Domain einen Eintrag für den kanonischen Namen (CNAME) hinzufügen, der auf {org_name}-portal.apigee.net verweist.

So bestätigen Sie den CNAME-Wert:

  1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
  2. Wählen Sie in der oberen Navigationsleiste oder auf der Landingpage im Drop-down-Menü die Option Einstellungen aus.
  3. Klicken Sie auf den Tab Domains.
  4. Sehen Sie sich im Bereich DNS konfigurieren den Wert CNAME für Ihre Organisation an, wie in der folgenden Abbildung dargestellt: DNS konfigurieren

Im Folgenden finden Sie ein Beispiel für einen CNAME-Eintrag, den Sie für die oben gezeigte benutzerdefinierte Domain konfigurieren würden, also für die benutzerdefinierte Domain developers.example.com in der Organisation myorg:

developers.example.com. CNAME myorg-portal.apigee.net.

Probleme mit benutzerdefinierten Domains beheben

In den folgenden Abschnitten finden Sie Vorschläge zur Fehlerbehebung bei benutzerdefinierten Domains.

Fehlerbehebung: DNS-Einrichtung der Domain mithilfe von „dig“ prüfen

Nachdem Ihr Domain-DNS aktualisiert wurde und den CNAME-Eintrag enthält, dauert es einige Zeit, bis die Änderungen auf andere DNS-Server weltweit übertragen werden. Sie können den DNS-Server Ihrer Domain mit dig abfragen, um zu prüfen, ob der CNAME-Eintrag korrekt eingerichtet wurde, noch bevor er vollständig an andere DNS-Server weitergegeben wurde.

Mit dem folgenden dig-Befehl wird beispielsweise der DNS-Server Ihrer Domain abgefragt. In der Befehlsausgabe enthält ANSWER SECTION den CNAME-Eintrag.

$ dig @your.domain.dns developer.mycompany.com
; <<>> DiG 9.8.3-P1 <<>> @your.domain.dns developer.mycompany.com
; (1 server found)
;; global options:  cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 41356
;; flags: qr rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 0, ADDITIONAL: 0
;; WARNING: recursion requested but not available

;; QUESTION SECTION:
;developer.mycompany.com.       IN  A

;; ANSWER SECTION:
developer.mycompany.com.    29  IN  CNAME   myorg-portal.apigee.net.

;; Query time: 141 msec
;; SERVER: 192.168.1.254#53(192.168.1.254)
;; WHEN: Mon Mar 20 16:41:59 2017
;; MSG SIZE  rcvd: 136

Fehlerbehebung: Proxy für Host konnte nicht ermittelt werden

Wenn Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzufügen, wird standardmäßig ein API-Proxy generiert, der die URL der benutzerdefinierten Domain verwendet, wobei als Zielendpunkt die Standarddomain des Portals festgelegt ist. Wenn Sie den mit einer benutzerdefinierten Domain verknüpften API-Proxy ändern oder löschen, wird die Konfiguration der benutzerdefinierten Domain ungültig und Sie erhalten die Fehlermeldung Unable to identify proxy for host, wenn Sie versuchen, auf die URL der benutzerdefinierten Domain zuzugreifen. Beispiel:


{"fault":{"faultstring":"Unable to identify proxy for host: developers.mycompany.com:443 and url: \/","detail":{"errorcode":"messaging.adaptors.http.flow.ApplicationNotFound"}}}

So stellen Sie die Konfiguration der benutzerdefinierten Domain wieder her, wenn der API-Proxy geändert oder gelöscht wurde:

  1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
  2. Wählen Sie in der oberen Navigationsleiste oder auf der Landingpage im Drop-down-Menü die Option Einstellungen aus.
  3. Klicken Sie auf den Tab Domains.
  4. Klicken Sie auf Speichern, um den API-Proxy wiederherzustellen.

Zertifikat aktualisieren

Allgemeine Informationen zum Aktualisieren von TLS-Zertifikaten finden Sie unter TLS-Zertifikat aktualisieren.

  1. Führen Sie die Schritte in Schritt 2: TLS konfigurieren aus.
  2. Führen Sie die Schritte in Schritt 3: Benutzerdefinierten Domainnamen zum Portal hinzufügen aus.