Dostosowywanie domeny

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Podczas tworzenia portalu dla deweloperów domyślnie otrzymujesz przykładową nazwę domeny Apigee, która umożliwia dostęp do aktywnego portalu w takim formacie:

https://orgname-portalname.apigee.io

Gdzie orgname to nazwa organizacji, a nazwa portalname jest zdefiniowana w postaci zapisanej wyłącznie małymi literami, bez spacji i myślników.

Przed uruchomieniem portalu dla programistów zalecamy podanie własnej nazwy domeny niestandardowej. Popularną alternatywą jest na przykład:

https://developers.example.com

Informacje o korzystaniu z domeny niestandardowej z dostawcą tożsamości SAML znajdziesz w artykule Korzystanie z domeny niestandardowej z dostawcą SAML.

W kolejnych sekcjach opisaliśmy, jak dostosować domenę.

Dostosowywanie nazwy domeny (Apigee Edge)

W przypadku zintegrowanych portali Apigee Edge możesz dostosować nazwę domeny, wykonując te czynności:

1. Zarejestruj nazwę domeny.
2. Skonfiguruj TLS.
3. Dodaj do portalu niestandardową nazwę domeny
4. Skonfiguruj DNS

Po dodaniu domeny niestandardowej możesz ją edytować lub wyłączyć. Aby dowiedzieć się, jak rozwiązać problemy, przeczytaj artykuł Rozwiązywanie problemów z domeną niestandardową.

Krok 1. Zarejestruj nazwę domeny

Jeśli chcesz zarejestrować nową domenę, możesz skorzystać z wielu popularnych witryn rejestracji domen, takich jak Google Domains. Wybór witryny rejestracji domen zależy od Ciebie.

Wybierając nazwę domeny, pamiętaj, że łatwe w użyciu i zrozumiałe adresy URL są kluczowym elementem procesu optymalizacji witryn pod kątem wyszukiwarek (SEO), który opisujemy w artykule Wdrażanie optymalizacji witryn pod kątem wyszukiwarek (SEO).

Krok 2. Skonfiguruj TLS

Aby obsługiwać HTTPS, musisz skonfigurować TLS, tworząc w środowisku portalu katalogi kluczy i aliasy zawierające niezbędne certyfikaty cyfrowe, zgodnie z opisem w tej procedurze.

Aby skonfigurować TLS:

1. Kup certyfikat TLS z renomowanego urzędu certyfikacji, takiego jak Google Trust Services. Wybór urzędu certyfikacji należy do Ciebie.
2. Zaloguj się na stronie https://apigee.com/edge.
3. W menu profilu użytkownika wybierz organizację.
4. Aby wyświetlić stronę kluczy TLS, kliknij Administracja > Środowisko > Klucze TLS.

5. Z menu środowiska wybierz portal.

   

6. Utwórz magazyn kluczy i alias zgodnie z opisem w artykule Tworzenie magazynów kluczy i magazynów zaufania za pomocą interfejsu użytkownika Edge.

Krok 3. Dodaj niestandardową nazwę domeny do swojego portalu

Gdy dodasz niestandardową nazwę domeny do portalu, system utworzy dla Ciebie te zasoby (korzystając z tej samej funkcji, która służy do zastosowania niestandardowej nazwy domeny do punktu końcowego, takiego jak api.example.com):

• Host wirtualny nasłuchujący na porcie 443 z użyciem określonej przez Ciebie niestandardowej nazwy domeny.

• Serwer proxy API korzystający z adresu URL domeny niestandardowej, którego docelowy punkt końcowy jest ustawiony na domyślną domenę portalu. Nazwa serwera proxy interfejsu API jest taka sama jak nazwa domeny niestandardowej, a kropki zastąpione podkreśleniami. Proxy interfejsu API jest wdrażane w środowisku portalu.

Aby dodać do portalu nazwę domeny niestandardowej:

1. Kliknij Opublikuj > Portale i wybierz swój portal.
2. Wybierz Ustawienia w menu na górnym pasku nawigacyjnym lub na stronie docelowej.
3. Kliknij kartę Domeny.
4. W sekcji Custom Domains (Domena niestandardowa) wypełnij następujące pola.
   

   Pole	Opis
   Magazyn kluczy	Wybierz z listy magazyn kluczy. Uwaga: lista jest wypełniana za pomocą repozytorium kluczy utworzonego w środowisku portalu w kroku 2. Po wybraniu magazynu kluczy pojawi się pole Alias.
   Alias	Wybierz prawidłowy alias z listy. Uwaga: lista jest wypełniana na podstawie aliasów utworzonych dla wybranego magazynu kluczy. Lista nie zawiera katalogów kluczy z nieprawidłowymi łańcuchami certyfikatów, domen Apigee ani katalogów z zaufanymi certyfikatami. Aby sprawdzić, kiedy certyfikat na liście wygaśnie: Wyświetl ikony: Certyfikat wygasa za ponad 30 dni lub wybrana domena niestandardowa może być już używana. Certyfikat wygasa po 30 dniach. Certyfikat wygasł. Umieść kursor nad aliasem, aby wyświetlić liczbę dni, przez które certyfikat będzie ważny. Po wybraniu aliasu wyświetli się pole Domena.
   Domena	Wybierz domenę z listy. Jeśli wybierzesz alias z symbolem wieloznaczeniowym, wpisz subdomenę. Uwaga: lista domen jest wypełniana za pomocą nazw wspólnych i alternatywnych certyfikatu najwyższego poziomu w łańcuchu zdefiniowanym przez wybrany alias.

   Gdy wypełnisz wszystkie pola, ikona stanu Domena niestandardowa zostanie zaktualizowana w ten sposób:

   Stan	Opis
   	Sklep z kluczami, alias i domena niestandardowa są prawidłowe.
   	Certyfikat wygaśnie w ciągu 30 dni.
   	Sklep kluczy, alias i domena niestandardowa są nieprawidłowe.

   Dodatkowo konfiguracja DNS jest sprawdzana, a ikona stanu Konfiguruj DNS jest aktualizowana w następujący sposób:

   Stan	Opis
   	Konfiguracja DNS jest prawidłowa.
   	Konfiguracja DNS jest nieprawidłowa. Musisz skonfigurować DNS zgodnie z instrukcjami podanymi w artykule Konfigurowanie DNS.

5. Kliknij Włącz (lub Zapisz, jeśli edytujesz).
   Własną domenę możesz włączyć nawet wtedy, gdy konfiguracja domeny niestandardowej lub DNS jest nieprawidłowa.

Krok 4. Skonfiguruj DNS

Następnie musisz dodać rekord nazwy kanonicznej (CNAME) do DNS domeny, aby wskazywał {org_name}-portal.apigee.net.

Aby potwierdzić wartość CNAME:

1. Kliknij Opublikuj > Portale i wybierz portal.
2. W menu na górnym pasku nawigacyjnym lub na stronie docelowej kliknij Ustawienia.
3. Kliknij kartę Domeny.
4. Wartość CNAME organizacji możesz wyświetlić w sekcji Skonfiguruj DNS, jak pokazano na rysunku:

Poniżej przedstawiamy przykład rekordu CNAME, który należy skonfigurować dla domeny niestandardowej widocznej powyżej (czyli domeny niestandardowej developers.example.com w organizacji myorg):

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

Rozwiązywanie problemów z domeną niestandardową

W poniższych sekcjach znajdziesz sugestie dotyczące rozwiązywania problemów z domeną niestandardową.

Rozwiązywanie problemów: sprawdzanie konfiguracji DNS domeny za pomocą dig

Gdy DNS domeny zostanie zaktualizowany, aby zawierać rekord CNAME, zmiany będą się rozprzestrzeniać na inne serwery DNS na całym świecie. Możesz wysłać zapytanie do serwera DNS domeny, aby sprawdzić, czy rekord CNAME został prawidłowo skonfigurowany, nawet zanim zostanie w pełni rozpowszechniony na inne serwery DNS. Użyj do tego polecenia dig.

Na przykład polecenie dig wysyła zapytanie do serwera DNS Twojej domeny. W wyniku polecenia ANSWER SECTION zawiera wpis rekordu CNAME.

$ 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

Rozwiązywanie problemów: nie można zidentyfikować serwera proxy dla hosta

Gdy dodasz do portalu nazwę niestandardowej domeny, domyślnie zostanie wygenerowany serwer proxy interfejsu API, który używa adresu URL niestandardowej domeny z docelowym punktem końcowym ustawionym na domyślną domenę portalu. Jeśli zmodyfikujesz lub usuniesz serwer proxy interfejsu API powiązany z domeną niestandardową, unieważnisz konfigurację tej domeny i podczas próby uzyskania dostępu do adresu URL domeny niestandardowej pojawi się komunikat o błędzie Unable to identify proxy for host. Na przykład:

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

Aby przywrócić niestandardową konfigurację domeny w przypadku, gdy serwer proxy interfejsu API został zmodyfikowany lub usunięty:

1. Kliknij Opublikuj > Portale, a następnie wybierz swój portal.
2. W menu na górnym pasku nawigacyjnym lub na stronie docelowej kliknij Ustawienia.
3. Kliknij kartę Domeny.
4. Aby przywrócić serwer proxy API, kliknij Zapisz.

Zaktualizuj certyfikat

Ogólne informacje o aktualizowaniu certyfikatów TLS znajdziesz w artykule Aktualizowanie certyfikatu TLS.

1. Wykonaj czynności opisane w sekcji Krok 2. Skonfiguruj TLS.
2. Wykonaj czynności opisane w sekcji Krok 3. Dodaj niestandardową nazwę domeny do portalu.