Personalizar seu domínio

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Por padrão, quando cria um portal do desenvolvedor, você recebe um exemplo de nome de domínio do Apigee no seguinte formato para acessar seu portal ativo:

https://orgname-portalname.apigee.io

Em que orgname é o nome da organização e portalname é definido usando o nome do portal convertido para letras minúsculas, com espaços e traços removidos.

Antes de lançar um portal do desenvolvedor, é recomendável fornecer seu próprio nome de domínio personalizado. Por exemplo, uma alternativa popular é:

https://developers.example.com

Para considerações sobre como usar um domínio personalizado com um provedor de identidade SAML, consulte Usar um domínio personalizado com o provedor SAML.

As seções a seguir descrevem como personalizar seu domínio.

Personalizar o nome de domínio (Apigee Edge)

Com os portais integrados do Apigee Edge, para personalizar seu nome de domínio, siga estas etapas:

  1. Registrar o nome do domínio
  2. Configurar o TLS.
  3. Adicione um nome de domínio personalizado ao seu portal.
  4. Configure o DNS.

Depois de adicionar um domínio personalizado, você pode editá-lo ou desativá-lo. Se precisar de ajuda, consulte Resolver problemas no seu domínio personalizado.

Etapa 1: registrar seu nome de domínio

Caso você precise registrar um novo domínio, há muitos sites populares de registro de domínio disponíveis, como o Google Domains. Você escolhe qual site de registro de domínio quer usar.

Ao decidir o nome de domínio, considere que URLs legíveis e fáceis de usar são um componente essencial para melhorar a otimização de mecanismos de pesquisa, conforme descrito em Implementar otimização de mecanismos de pesquisa (SEO, na sigla em inglês).

Etapa 2: configurar o TLS

Para oferecer suporte a HTTPS, configure o TLS criando keystores e aliases que contenham os certificados digitais necessários no ambiente do portal, conforme descrito no procedimento a seguir.

Para configurar o TLS:

  1. Compre um certificado TLS de uma autoridade certificadora respeitável, como o Google Trust Services. Você decide qual autoridade certificadora escolher.
  2. Faça login em https://apigee.com/edge.
  3. Selecione sua organização no menu do perfil do usuário.
  4. Selecione Administrador > Ambiente > Keystores TLS para exibir a página de keystores TLS.

  5. Selecione portal na lista suspensa do ambiente.

  6. Crie um keystore e um alias, conforme descrito em Como criar keystores e truststore usando a IU do Edge.

Etapa 3: adicionar um nome de domínio personalizado ao portal

Quando você adiciona um nome de domínio personalizado ao seu portal, o sistema cria os seguintes recursos para você usando a mesma funcionalidade usada para aplicar um nome de domínio personalizado a um endpoint, como api.example.com:

  • Um host virtual detectando na porta 443 usando o nome de domínio personalizado que você especificar.

  • Um proxy de API usando o URL do domínio personalizado com o endpoint de destino definido como o domínio do portal padrão. O nome do proxy de API corresponde ao nome de domínio personalizado com os pontos substituídos por sublinhados. O proxy de API é implantado no ambiente do portal.

Para adicionar um nome de domínio personalizado ao seu portal:

  1. Selecione Publish > Portals e selecione seu portal.
  2. Selecione Configurações no menu suspenso na barra de navegação superior ou na página de destino.
  3. Clique na guia Domínios.
  4. Em Domínio personalizado, preencha os campos a seguir.
    Campo Descrição
    Keystore Selecione um keystore na lista suspensa.

    Observação: a lista é preenchida usando os keystores que você criou no ambiente do portal na etapa 2.

    Depois de selecionar um keystore, o campo Alias será exibido.

    Alias Selecione um alias válido na lista suspensa.

    Observação: a lista é preenchida usando os aliases que você criou para o keystore selecionado. A lista não inclui keystores com cadeias de certificados, domínios da Apigee ou truststores inválidos.

    Para determinar quando um certificado da lista vai expirar:

    • Veja os ícones:
      • o certificado é válido O certificado expira em mais de 30 dias ou o domínio personalizado selecionado já está em uso.
      • o certificado expira em 30 dias O certificado expira em 30 dias.
      • o certificado expirou O certificado expirou.
    • Posicione o cursor sobre um alias para exibir o número de dias restantes na validade do certificado.

    Depois que você selecionar um alias, o campo Domínio será exibido.

    Domínio Selecione um domínio na lista suspensa. Se você selecionou um alias com caractere curinga, digite o subdomínio.

    Observação:a lista de domínios é preenchida usando os nomes comuns e alternativos do certificado de nível superior na cadeia definida pelo alias selecionado.
    Depois que você preencher todos os campos, o ícone de status do Domínio personalizado será atualizado da seguinte maneira:
    Status Descrição
    Status válido O keystore, o alias e o domínio personalizado são válidos.
    O certificado expira em 30 dias O certificado expira em 30 dias.
    Status inválido O keystore, o alias e o domínio personalizado são inválidos.
    Além disso, a configuração de DNS é validada, e o ícone de status "Configurar DNS" será atualizado da seguinte maneira:
    Status Descrição
    Status válido A configuração de DNS é válida.
    Status inválido A configuração de DNS não é válida. É preciso configurar o DNS, conforme descrito em Configuração do DNS.
  5. Clique em Ativar (ou Salvar se estiver editando).
    É possível ativar seu domínio personalizado mesmo que a configuração de DNS ou domínio personalizado seja inválida.

Etapa 4: configurar o DNS

Em seguida, adicione um registro de nome canônico (CNAME) ao DNS do domínio que aponte para {org_name}-portal.apigee.net.

Para confirmar o valor CNAME, siga estas etapas:

  1. Selecione Publicar > Portais e selecione seu portal.
  2. Selecione Configurações no menu suspenso na barra de navegação superior ou na página de destino.
  3. Clique na guia Domínios.
  4. Confira o valor de CNAME para sua organização na seção Configure DNS, conforme mostrado na figura a seguir: Configura o DNS

Veja a seguir um exemplo do registro CNAME que você configuraria para o domínio personalizado mostrado acima (ou seja, para o domínio personalizado developers.example.com na organização myorg):

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

Resolver problemas no seu domínio personalizado

As seções a seguir oferecem sugestões para resolver problemas no seu domínio personalizado.

Solução de problemas: verificar a configuração de DNS do domínio usando o Dig

Depois que o DNS do seu domínio for atualizado para incluir o registro CNAME, levará algum tempo para que as alterações sejam propagadas para outros servidores DNS no mundo todo. É possível consultar o servidor DNS do seu domínio para verificar se o registro CNAME foi configurado corretamente, mesmo antes de ser totalmente propagado para outros servidores DNS, usando dig.

Por exemplo, o comando dig a seguir consulta o servidor DNS do seu domínio. Na resposta ao comando, ANSWER SECTION contém a entrada de registro 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

Solução de problemas: não foi possível identificar o proxy do host

Quando você adiciona um nome de domínio personalizado ao portal, um proxy de API é gerado por padrão que usa o URL do domínio personalizado com o endpoint de destino definido como o domínio do portal padrão. Se modificar ou excluir o proxy de API associado a um domínio personalizado, você invalidará a configuração do domínio personalizado e receberá uma mensagem de erro Unable to identify proxy for host ao tentar acessar o URL do domínio personalizado. Exemplo:


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

Para restaurar a configuração do domínio personalizado caso o proxy de API tenha sido modificado ou excluído:

  1. Selecione Publicar > Portais e selecione seu portal.
  2. Selecione Configurações no menu suspenso na barra de navegação superior ou na página de destino.
  3. Clique na guia Domínios.
  4. Clique em Save para restaurar o proxy de API.

Atualizar seu certificado

Para informações gerais sobre como atualizar certificados TLS, consulte Atualizar um certificado TLS.

  1. Siga as instruções da Etapa 2: configurar o TLS.
  2. Siga as instruções da Etapa 3: adicionar um nome de domínio personalizado ao seu portal.