Modificações na IU

É possível fazer pequenas alterações na IU do Edge para melhorar a experiência da comunidade de desenvolvedores. Por exemplo, é possível mudar o seguinte:

  • Contato de suporte:o destinatário dos erros internos da interface.
  • Banner de consentimento:texto exibido quando um usuário acessa a interface do Edge pela primeira vez. O banner de consentimento mostra um texto formatado em HTML e um botão que o usuário seleciona para prosseguir para a tela de login.

Mudar essas configurações vai oferecer aos desenvolvedores uma experiência mais coesa e ajudar a garantir que os problemas sejam encaminhados para o lugar certo.

Para fazer essas mudanças, edite os arquivos de propriedades usando a técnica de código com configuração (CwC, na sigla em inglês).

Mudar o contato de suporte

Quando a interface apresenta determinados erros (por exemplo, quando um desenvolvedor faz login como um usuário que não tem uma organização associada), um erro como o seguinte pode ser apresentado:

Mude o valor padrão do contato da "equipe de suporte" para apontar para um recurso ativo na sua organização que possa fornecer assistência oportuna aos desenvolvedores.

Para mudar o contato de suporte:

  1. Abra o arquivo /opt/apigee/customer/application/ui.properties em um editor. Se o arquivo não existir, crie-o.
  2. Se você acabou de criar o arquivo, mude o proprietário para "apigee:apigee", como mostra o exemplo a seguir: 
    chown apigee:apigee /opt/apigee/customer/application/ui.properties
  3. Defina o valor da propriedade conf_apigee_apigee.branding.contactemailsupport como seu contato de suporte interno. Exemplo: 
    conf_apigee_apigee.branding.contactemailsupport="api-support@mycompany.com"
  4. Salve as alterações.
  5. Reinicie o serviço da interface do Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Na próxima vez que os desenvolvedores tiverem um erro interno, o link "Entrar em contato com a equipe" vai enviar um e-mail para sua organização de suporte interno.

O banner de consentimento é exibido quando um usuário acessa a interface do Edge pela primeira vez. Exemplo:

Para adicionar um banner de consentimento:

  1. Abra o arquivo /opt/apigee/customer/application/ui.properties em um editor. Se o arquivo não existir, crie-o.
  2. Se você acabou de criar o arquivo, mude o proprietário para "apigee:apigee", como mostra o exemplo a seguir: 
    chown apigee:apigee /opt/apigee/customer/application/ui.properties
  3. Defina as seguintes propriedades: 
    # Enable the consent banner:
conf_apigee-base_apigee.feature.enableconsentbanner="true"
# Set the button text:
conf_apigee-base_apigee.consentbanner.buttoncaption="I Agree"
# Set the HTML text:
conf_apigee-base_apigee.consentbanner.body="<h1>Notice and Consent Banner</h1>
<div><p>Enter your consent text here.</p></div>"
  4. Salve as alterações.
  5. Reinicie o serviço da interface do Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Na próxima vez que os desenvolvedores abrirem a IU do Edge em um navegador, eles precisarão aceitar o contrato de consentimento antes de fazer login.