Domain personalisieren

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X. info

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)

So passen Sie Ihren Domainnamen in integrierten Apigee Edge-Portalen an:

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

Nachdem Sie eine benutzerdefinierte Domain hinzugefügt haben, können Sie sie bearbeiten oder deaktivieren. Hilfe zur Fehlerbehebung finden Sie unter Fehlerbehebung bei Problemen mit benutzerdefinierten Domains.

Schritt 1: 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, indem Sie in der Portalumgebung Schlüsselspeicher und Aliase erstellen, die die erforderlichen digitalen Zertifikate enthalten. Die Vorgehensweise ist unten beschrieben.

So konfigurieren Sie TLS:

1. Erwerben Sie ein TLS-Zertifikat von einer seriösen Zertifizierungsstelle wie Google Trust Services. Sie entscheiden, welche Zertifizierungsstelle Sie auswählen.
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 Admin > Umgebung > TLS-Schlüsselspeicher aus, um die Seite „TLS-Schlüsselspeicher“ aufzurufen.

5. Wählen Sie im Drop-down-Menü „Umgebung“ die Option portal aus.

   

6. Erstellen Sie einen Schlüsselspeicher und einen Alias, wie unter Schlüsselspeicher und Truststore über die Edge-UI erstellen beschrieben.

Schritt 3: Portal einen benutzerdefinierten Domainnamen hinzufügen

Wenn Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzufügen, werden die folgenden Ressourcen für Sie erstellt (mit derselben Funktion, die verwendet wird, um einen benutzerdefinierten Domainnamen auf einen Endpunkt wie api.example.com anzuwenden):

• Ein virtueller Host, der auf Port 443 mit dem von Ihnen angegebenen benutzerdefinierten Domainnamen wartet.

• Ein API-Proxy mit der URL der benutzerdefinierten Domain, wobei der Zielendpunkt auf die Standardportaldomain 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. Wählen Sie Veröffentlichen > Portale und anschließend 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.
   

   Feld	Beschreibung
   Schlüsselspeicher	Wählen Sie in der Drop-down-Liste einen Schlüsselspeicher aus. Hinweis: Die Liste wird mit den Schlüsselspeichern 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 Aliasen 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 ermitteln Sie, wann ein Zertifikat in der Liste abläuft: Sehen Sie sich die Symbole an: Das Zertifikat läuft in mehr als 30 Tagen ab oder die ausgewählte benutzerdefinierte Domain ist möglicherweise bereits in Verwendung. Das Zertifikat läuft innerhalb von 30 Tagen ab. Das Zertifikat ist abgelaufen. Bewegen Sie den Mauszeiger auf einen Alias, um die verbleibende Anzahl der Tage anzuzeigen, an denen das Zertifikat gültig ist. Nachdem Sie einen Alias ausgewählt haben, wird das Feld Domain angezeigt.
   Domain	Wählen Sie in der Drop-down-Liste eine Domain aus. Wenn Sie einen Alias mit Platzhalter ausgewählt haben, geben Sie die Subdomain ein. Hinweis:Die Liste der Domains wird mit den allgemeinen und alternativen Namen für das Zertifikat der obersten Ebene in der Kette gefüllt, die durch den ausgewählten Alias definiert wird.

   Nachdem Sie alle Felder ausgefüllt haben, wird das Statussymbol Benutzerdefinierte Domain wie folgt aktualisiert:

   Status	Beschreibung
   	Schlüsselspeicher, Alias und benutzerdefinierte Domain sind gültig.
   	Das Zertifikat läuft innerhalb von 30 Tagen ab.
   	Schlüsselspeicher, Alias und benutzerdefinierte Domain sind ungültig.

   Außerdem wird die DNS-Konfiguration validiert und das Statussymbol „DNS konfigurieren“ wird wie folgt aktualisiert:

   Status	Beschreibung
   	Die DNS-Konfiguration ist gültig.
   	Die DNS-Konfiguration ist ungültig. Sie müssen Ihr DNS konfigurieren, wie unter DNS konfigurieren beschrieben.

5. Klicken Sie auf Aktivieren (oder auf Speichern , wenn Sie Änderungen vornehmen).
   Sie können Ihre benutzerdefinierte Domain auch dann aktivieren, wenn die benutzerdefinierte Domain oder die DNS-Konfiguration ungültig ist.

Schritt 4: DNS konfigurieren

Als Nächstes müssen Sie Ihrer Domain-DNS einen CNAME-Eintrag (Canonical Name) 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 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. Sehen Sie sich im Abschnitt DNS konfigurieren den CNAME -Wert für Ihre Organisation an, wie in der folgenden Abbildung gezeigt:

Im Folgenden sehen Sie ein Beispiel für den CNAME-Eintrag, den Sie für die oben gezeigte benutzerdefinierte Domain konfigurieren würden (d. h. für die benutzerdefinierte Domain developers.example.com in der Organisation myorg):

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

Fehlerbehebung bei Problemen mit benutzerdefinierten Domains

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

Fehlerbehebung: Domain-DNS-Einrichtung mit „dig“ überprüfen

Nachdem Ihr Domain-DNS mit dem CNAME-Eintrag aktualisiert wurde, dauert es einige Zeit, bis die Änderungen an andere DNS-Server weltweit weitergegeben werden. Sie können Ihren Domain-DNS-Server abfragen, um zu prüfen, ob der CNAME-Eintrag korrekt eingerichtet wurde, auch bevor er vollständig an andere DNS-Server weitergegeben wurde. Verwenden Sie dazu „dig“.

Mit dem folgenden dig-Befehl wird beispielsweise Ihr Domain-DNS-Server abgefragt. In der Befehlsausgabe enthält der Abschnitt 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: Unable to identify proxy for host

Wenn Sie Ihrem Portal einen benutzerdefinierten Domainnamen hinzufügen, wird standardmäßig ein API-Proxy generiert, der die URL der benutzerdefinierten Domain verwendet, wobei der Zielendpunkt auf die Standardportaldomain festgelegt ist. Wenn Sie den API-Proxy, der mit einer benutzerdefinierten Domain verknüpft ist, ändern oder löschen, machen Sie die Konfiguration der benutzerdefinierten Domain ungültig und 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, falls der API-Proxy geändert oder gelöscht wurde:

1. Wählen Sie Veröffentlichen > Portale und anschließend 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. 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. Folgen Sie der Anleitung unter Schritt 2: TLS konfigurieren.
2. Folgen Sie der Anleitung unter Schritt 3: Portal einen benutzerdefinierten Domainnamen hinzufügen