Personalizzare il dominio

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Quando crei un portale per sviluppatori, per impostazione predefinita ti viene fornito un nome di dominio Apigee di esempio per accedere al portale attivo nel seguente formato:

https://orgname-portalname.apigee.io

dove orgname è il nome dell'organizzazione e portalname è definito utilizzando il nome del portale convertito in lettere minuscole e con spazi e trattini rimossi.

Prima di lanciare un portale per gli sviluppatori, ti consigliamo di fornire un nome di dominio personalizzato. Ad esempio, un'alternativa molto utilizzata è:

https://developers.example.com

Per le considerazioni sull'utilizzo di un dominio personalizzato con un provider di identità SAML, consulta Utilizzare un dominio personalizzato con il provider SAML.

Le seguenti sezioni descrivono come personalizzare il tuo dominio.

Personalizzare il nome di dominio (Apigee Edge)

Con i portali integrati di Apigee Edge, per personalizzare il nome di dominio, segui questi passaggi:

  1. Registra il tuo nome di dominio.
  2. Configura TLS.
  3. Aggiungi un nome di dominio personalizzato al portale.
  4. Configura il DNS.

Dopo aver aggiunto un dominio personalizzato, puoi modificarlo o disattivarlo. Per assistenza nella risoluzione dei problemi, consulta Risolvere i problemi relativi al dominio personalizzato.

Passaggio 1: registra il tuo nome di dominio

Se devi registrare un nuovo dominio, sono disponibili molti siti di registrazione di domini popolari, come Google Domains. È a tua discrezione scegliere il sito di registrazione del dominio.

Quando scegli il nome di dominio, tieni presente che gli URL facili da usare e leggibili sono un componente chiave per migliorare l'ottimizzazione per i motori di ricerca, come descritto in Implementare l'ottimizzazione per i motori di ricerca (SEO).

Passaggio 2: configura TLS

Per supportare HTTPS, è necessario configurare TLS creando archivi chiavi e alias che contengono i certificati digitali necessari nell'ambiente del portale, come descritto nella procedura seguente.

Per configurare TLS:

  1. Acquista un certificato TLS da un'autorità di certificazione attendibile, come Google Trust Services. La scelta dell'autorità di certificazione è a tua discrezione.
  2. Accedi all'indirizzo https://apigee.com/edge.
  3. Seleziona la tua organizzazione dal menu del profilo utente.
  4. Seleziona Amministrazione > Ambiente > Magazzini chiavi TLS per visualizzare la pagina dei magazzini chiavi TLS.

  5. Seleziona portale dal menu a discesa dell'ambiente.

  6. Crea un archivio chiavi e un alias, come descritto in Creare archivi chiavi e truststore utilizzando l'interfaccia utente di Edge.

Passaggio 3: aggiungi un nome di dominio personalizzato al tuo portale

Quando aggiungi un nome di dominio personalizzato al tuo portale, il sistema crea le seguenti risorse (utilizzando la stessa funzionalità utilizzata per applicare un nome di dominio personalizzato a un endpoint come api.example.com):

  • Un host virtuale in ascolto sulla porta 443 che utilizza il nome di dominio personalizzato specificato.

  • Un proxy API che utilizza l'URL del dominio personalizzato con l'endpoint di destinazione impostato sul dominio del portale predefinito. Il nome del proxy API corrisponde al nome di dominio personalizzato con i punti sostituiti da trattini bassi. Il proxy API viene dispiegato nell'ambiente del portale.

Per aggiungere un nome di dominio personalizzato al tuo portale:

  1. Seleziona Pubblica > Portali e seleziona il tuo portale.
  2. Seleziona Impostazioni nel menu a discesa nella barra di navigazione in alto o nella pagina di destinazione.
  3. Fai clic sulla scheda Domains (Domini).
  4. In Dominio personalizzato, compila i seguenti campi.
    Campo Descrizione
    Archivio chiavi Seleziona un keystore dall'elenco a discesa.

    Nota: l'elenco viene compilato utilizzando i keystore che hai creato nell'ambiente del portale nel passaggio 2.

    Dopo aver selezionato un archivio chiavi, viene visualizzato il campo Alias.

    Alias Seleziona un alias valido dall'elenco a discesa.

    Nota: l'elenco viene compilato utilizzando gli alias che hai creato per il keystore selezionato. L'elenco non include i keystore con catene di certificati non valide, domini Apigee o store delle credenziali.

    Per determinare la scadenza di un certificato nell'elenco:

    • Visualizza le icone:
      • Il certificato è valido Il certificato scade tra più di 30 giorni o il dominio personalizzato selezionato potrebbe essere già in uso.
      • il certificato scade tra 30 giorni Il certificato scade entro 30 giorni.
      • certificato scaduto Il certificato è scaduto.
    • Posiziona il cursore su un alias per visualizzare il numero di giorni rimanenti di validità del certificato.

    Dopo aver selezionato un alias, viene visualizzato il campo Dominio.

    Dominio Seleziona un dominio dall'elenco a discesa. Se hai selezionato un alias jolly, inserisci il sottodominio.

    Nota:l'elenco dei domini viene compilato utilizzando i nomi comuni e alternativi per il certificato di primo livello nella catena definita dall'alias selezionato.
    Dopo aver completato tutti i campi, l'icona di stato Dominio personalizzato verrà aggiornata come segue:
    Stato Descrizione
    Stato valido Archivio chiavi, alias e dominio personalizzato sono validi.
    Il certificato scade tra 30 giorni Il certificato scadrà entro 30 giorni.
    Stato non valido Archivio chiavi, alias e dominio personalizzato non validi.
    Inoltre, la configurazione DNS viene convalidata e l'icona dello stato della configurazione DNS viene aggiornata come segue:
    Stato Descrizione
    Stato valido La configurazione DNS è valida.
    Stato non valido La configurazione DNS non è valida. Devi configurare il DNS, come descritto in Configurazione del DNS.
  5. Fai clic su Attiva (o su Salva se apporti modifiche).
    Puoi attivare il dominio personalizzato anche se il dominio personalizzato o la configurazione DNS non è valida.

Passaggio 4: configura il DNS

Successivamente, devi aggiungere un record CNAME al DNS del tuo dominio in modo che punti a {org_name}-portal.apigee.net.

Per confermare il valore CNAME:

  1. Seleziona Pubblica > Portali e seleziona il tuo portale.
  2. Seleziona Impostazioni nel menu a discesa nella barra di navigazione in alto o nella pagina di destinazione.
  3. Fai clic sulla scheda Domini.
  4. Visualizza il valore CNAME per la tua organizzazione nella sezione Configura DNS, come mostrato nella figura seguente: Configura il DNS

Di seguito è riportato un esempio del record CNAME da configurare per il dominio personalizzato mostrato sopra (ovvero per il dominio personalizzato developers.example.com nell'organizzazione myorg):

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

Risolvere i problemi relativi al dominio personalizzato

Le seguenti sezioni forniscono suggerimenti per la risoluzione dei problemi relativi al dominio personalizzato.

Risoluzione dei problemi: verifica la configurazione DNS del dominio utilizzando dig

Dopo che il DNS del tuo dominio è stato aggiornato in modo da includere il record CNAME, le modifiche richiedono del tempo per essere propagate ad altri server DNS in tutto il mondo. Puoi eseguire una query sul server DNS del tuo dominio per verificare che il record CNAME sia stato configurato correttamente, anche prima che venga completamente propagato ad altri server DNS, utilizzando dig.

Ad esempio, il seguente comando dig esegue una query sul server DNS del tuo dominio. Nell'output del comando, ANSWER SECTION contiene la voce del record 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

Risoluzione dei problemi: impossibile identificare il proxy per l'host

Quando aggiungi un nome di dominio personalizzato al tuo portale, per impostazione predefinita viene generato un proxy API che utilizza l'URL del dominio personalizzato con l'endpoint di destinazione impostato sul dominio del portale predefinito. Se modifichi o elimini il proxy API associato a un dominio personalizzato, la configurazione del dominio personalizzato verrà invalidata e riceverai un messaggio di errore Unable to identify proxy for host quando tenterai di accedere all'URL del dominio personalizzato. Ad esempio:


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

Per ripristinare la configurazione del dominio personalizzato nel caso in cui il proxy API sia stato modificato o eliminato:

  1. Seleziona Pubblica > Portali e seleziona il tuo portale.
  2. Seleziona Impostazioni nel menu a discesa nella barra di navigazione in alto o nella pagina di destinazione.
  3. Fai clic sulla scheda Domains (Domini).
  4. Fai clic su Salva per ripristinare il proxy API.

Aggiornare il certificato

Per informazioni generali sull'aggiornamento dei certificati TLS, consulta Aggiornare un certificato TLS.

  1. Segui i passaggi descritti in Passaggio 2: configura TLS.
  2. Segui i passaggi descritti nel passaggio 3: aggiungi un nome di dominio personalizzato al tuo portale