Personalizzare il dominio

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

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

https://orgname-portalname.apigee.io

Dove orgname è il nome dell'organizzazione e portalname viene definito utilizzando il nome del portale convertito in tutto minuscolo e con spazi e trattini rimossi.

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

https://developers.example.com

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

Nelle sezioni seguenti viene descritto come personalizzare il dominio.

Personalizzare il nome di dominio (Apigee Edge)

Con i portali integrati Apigee Edge, per personalizzare il tuo 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 disabilitarlo. Per assistenza con la risoluzione dei problemi, vedi 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. Sta a te scegliere quale sito di registrazione del dominio puoi scegliere.

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

Passaggio 2: configura TLS

Per supportare HTTPS, devi configurare TLS creando archivi chiavi e alias contenenti 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 affidabile, come Google Trust Services. L'autorità di certificazione che scegli spetta a te.
  2. Accedi ad https://apigee.com/edge.
  3. Seleziona la tua organizzazione dal menu del profilo utente.
  4. Seleziona Amministrazione > Ambiente > Archivi chiavi TLS per visualizzare la pagina degli archivi chiavi TLS.
  5. Seleziona portale dal menu a discesa dell'ambiente.

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

Passaggio 3: aggiungi un nome di dominio personalizzato al portale

Quando aggiungi un nome di dominio personalizzato al portale, il sistema crea automaticamente 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, utilizzando il nome di dominio personalizzato da te specificato.

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

Per aggiungere un nome di dominio personalizzato al portale:

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

    Nota: l'elenco viene compilato utilizzando gli archivi chiavi 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 l'archivio chiavi selezionato. L'elenco non include archivi chiavi con catene di certificati, domini Apigee o archivi di attendibilità non validi.

    Per determinare la scadenza di un certificato nell'elenco:

    • Visualizza le icone:
      • certificato valido Il certificato scade tra più di 30 giorni oppure 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 di validità del certificato rimanenti.

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

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

    Nota:l'elenco dei domini viene compilato utilizzando i nomi comuni e alternativi del certificato di primo livello nella catena definita dall'alias selezionato.

    Dopo aver compilato tutti i campi, l'icona di stato Dominio personalizzato verrà aggiornata come segue:
    Stato Descrizione
    Stato valido L'archivio chiavi, l'alias e il dominio personalizzato sono validi.
    Il certificato scadrà tra 30 giorni Il certificato scadrà entro 30 giorni.
    Stato non valido L'archivio chiavi, l'alias e il dominio personalizzato non sono validi.
    Inoltre, la configurazione DNS viene convalidata e l'icona di stato Configura 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 Configurare il DNS.
  5. Fai clic su Attiva (o Salva se stai apportando modifiche).
    Puoi abilitare il tuo dominio personalizzato anche se la configurazione DNS o il dominio personalizzato non è valido.

Passaggio 4: configura il DNS

Successivamente, devi aggiungere un record con nome canonico (CNAME) al DNS del tuo dominio perché punti a {org_name}-portal.apigee.net.

Per verificare il valore CNAME:

  1. Seleziona Pubblica > Portali e seleziona il tuo portale.
  2. Seleziona Impostazioni nel menu a discesa della 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 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.

Risolvere i problemi: verificare la configurazione DNS del dominio utilizzando dig

Una volta aggiornato il DNS del tuo dominio in modo da includere il record CNAME, sarà necessario un po' di tempo prima che le modifiche vengano 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 propagato completamente ad altri server DNS, utilizzando dig.

Ad esempio, il seguente comando dig esegue una query sul server DNS del tuo dominio. Nell'output 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 portale, per impostazione predefinita viene generato un proxy API che utilizza l'URL del dominio personalizzato con l'endpoint di destinazione impostato sul dominio predefinito del portale. Se modifichi o elimini il proxy API associato a un dominio personalizzato, la configurazione del dominio personalizzato verrà invalidata e verrà visualizzato un messaggio di errore Unable to identify proxy for host quando tenti 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 della barra di navigazione in alto o nella pagina di destinazione.
  3. Fai clic sulla scheda Domini.
  4. Fai clic su Salva per ripristinare il proxy API.

Aggiorna il certificato

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

  1. Segui la procedura descritta nel Passaggio 2: configura TLS.
  2. Segui i passaggi descritti nel Passaggio 3: aggiungi un nome di dominio personalizzato al portale