Partilhar via

Como configurar notificações e modelos de notificação no Gerenciamento de API do Azure

APLICA-SE A: Developer | Básico | Básico v2 | Padrão | Padrão v2 | Prémio | Premium v2

O Gerenciamento de API do Azure permite configurar notificações por email para eventos específicos e configurar os modelos de email usados para se comunicar com os administradores e desenvolvedores de uma instância de Gerenciamento de API. Este artigo mostra como configurar notificações para os eventos disponíveis e fornece uma visão geral da configuração dos modelos de email usados para esses eventos.

Pré-requisitos

Se você não tiver uma instância de serviço de Gerenciamento de API, conclua o seguinte início rápido: Criar uma instância de Gerenciamento de API do Azure.

Vá para a sua instância de Gestão de API

  1. No Portal do Azure , procure e selecione Serviços de Gestão de API:

    Captura de tela que mostra os serviços de Gerenciamento de API nos resultados da pesquisa.

  2. Na página de serviços de Gerenciamento de API, selecione sua instância de Gerenciamento de API:

    Captura de tela que mostra uma instância de Gerenciamento de API na página Serviços de Gerenciamento de API.

Configurar notificações no portal do Azure

  1. No menu da barra lateral da sua instância de Gerenciamento de API, selecione Implantação + infraestrutura e escolha Notificações para exibir as notificações disponíveis.

    A lista de eventos a seguir pode ser configurada para notificações.

    • Solicitações de assinatura (exigindo aprovação): os destinatários e usuários de e-mail especificados recebem notificações por e-mail sobre solicitações de assinatura para produtos que exigem aprovação.
    • Novas assinaturas: os destinatários e usuários de e-mail especificados recebem notificações por e-mail sobre novas assinaturas de produtos.
    • Solicitações da galeria de aplicativos: os seguintes destinatários e usuários de e-mail recebem notificações por e-mail quando novos aplicativos são enviados para a galeria de aplicativos.
    • BCC: Os destinatários e utilizadores de email especificados recebem cópias carbone ocultas de todos os emails enviados aos desenvolvedores.
    • Novo problema ou comentário: os seguintes destinatários e usuários de e-mail recebem notificações por e-mail quando um novo problema ou comentário é enviado no portal do desenvolvedor.
    • Mensagem de fechar conta: os destinatários e usuários de e-mail especificados recebem notificações por e-mail quando uma conta é fechada.
    • Aproximando-se do limite de cota de assinatura: os destinatários e usuários de email especificados recebem notificações por e-mail quando o uso da assinatura se aproxima da cota de uso.

  2. Selecione uma notificação e especifique um ou mais endereços de e-mail a serem notificados:

    • Para adicionar o endereço de e-mail do administrador, selecione + Adicionar administrador.
    • Para adicionar outro endereço de e-mail, selecione + Adicionar e-mail, insira um endereço de e-mail e selecione Adicionar.
    • Continue adicionando endereços de e-mail conforme necessário.

    Captura de ecrã a mostrar como adicionar destinatários de notificação no portal.

Configurar modelos de notificação

O Gerenciamento de API fornece modelos de notificação para as mensagens de email administrativas que são enviadas automaticamente aos desenvolvedores quando eles acessam e usam o serviço. Os seguintes modelos de notificação são fornecidos:

  • Carta de despedida do desenvolvedor
  • Notificação de aproximação do limite de cota de desenvolvedor
  • Carta de boas-vindas do desenvolvedor
  • Notificação de alteração de e-mail
  • Convidar utilizador
  • Confirmação da nova conta de programador
  • Nova subscrição ativada
  • Confirmação de alteração de palavra-passe
  • Pedido de subscrição recusado
  • Pedido de subscrição recebido

Cada modelo de email tem uma linha de assunto em texto sem formatação e uma definição de corpo em formato HTML. Cada item pode ser personalizado conforme desejado.

Nota

O conteúdo HTML em um modelo deve ser bem formado e aderir à especificação XML. O   caractere não é permitido.

Para visualizar e configurar um modelo de notificação no portal:

  1. No menu da barra lateral, selecione Modelos de notificação. Captura de ecrã dos modelos de notificação no portal.

  2. Selecione um modelo de notificação e configure o modelo usando o editor.

    Captura de tela do editor de modelo de notificação no portal.

    • A lista Parâmetros contém uma lista de parâmetros que, quando inseridos no assunto ou corpo, são substituídos pelo valor designado quando o e-mail é enviado.
    • Para inserir um parâmetro, coloque o cursor onde deseja que o parâmetro vá e selecione o nome do parâmetro.

  3. Para salvar as alterações no modelo de email, selecione Salvar ou descartar para cancelar as alterações.

Definir configurações de e-mail

Pode modificar as definições gerais de e-mail para notificações enviadas a partir da sua instância Gestão de API. Pode alterar o endereço de e-mail do administrador, o nome da organização que envia notificações e o endereço de e-mail de origem.

Importante

Alterar o endereço de e-mail de origem pode afetar a capacidade dos destinatários de receber e-mails. Veja as considerações na seção a seguir.

Para modificar as configurações de e-mail:

  1. No menu da barra lateral, selecione Modelos de notificação.

  2. Selecione Configurações de e-mail.

  3. Na página Configurações gerais de email , insira valores para:

    • E-mail do administrador: o endereço de e-mail para receber todas as notificações do sistema e outras notificações configuradas.

    • Nome da organização: o nome da sua organização para uso no portal do desenvolvedor e notificações.

    • Endereço de e-mail de origem: o valor do cabeçalho De para notificações da instância de Gerenciamento de API. O Gerenciamento de API envia notificações em nome desse endereço de origem.

      Captura de tela das configurações de e-mail do Gerenciamento de API no portal

  4. Selecione Guardar.

Considerações para alterar o endereço de e-mail de origem

Os destinatários de notificações por e-mail do Gerenciamento de API podem ser afetados quando você altera o endereço de e-mail de origem.

  • Alterar o endereço De: Quando você alterar o endereço de e-mail de origem (por exemplo, para no-reply@contoso.com), o cabeçalho do endereço De será noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Isso ocorre porque o e-mail está sendo enviado pelo Gerenciamento de API, e não pelo servidor de e-mail do endereço de e-mail de origem.

  • E-mail enviado para a pasta de lixo eletrônico ou spam: alguns destinatários podem não receber as notificações por e-mail do Gerenciamento de API ou os e-mails podem ser enviados para a pasta de lixo eletrônico ou spam. Isso pode acontecer dependendo das configurações de autenticação de e-mail SPF ou DKIM da organização:

    • Autenticação SPF: o e-mail pode não passar mais pela autenticação SPF depois que você alterar o domínio do endereço de e-mail de origem. Para garantir a autenticação SPF bem-sucedida e a entrega de e-mails, crie o seguinte registro TXT no banco de dados DNS do domínio especificado no endereço de e-mail. Por exemplo, se o endereço de e-mail for noreply@contoso.com, entre em contato com o administrador do contoso.com para adicionar o seguinte registro TXT: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • Autenticação DKIM: Para gerar uma assinatura válida para DKIM para autenticação de e-mail, o Gerenciamento de API requer a chave privada associada ao domínio do endereço de e-mail de origem. No entanto, atualmente não é possível carregar essa chave privada no Gerenciamento de API. Portanto, para atribuir uma assinatura válida, o Gerenciamento de API usa a chave privada associada ao mail.windowsazure.com domínio.

Conteúdo relacionado

  • Last updated on