Compartilhar via

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

APPLIES TO: Desenvolvedor | Básico | Básico v2 | Padrão | Standard v2 | Premium | 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 de eventos disponíveis e fornece uma visão geral da configuração dos modelos dos emails usados desses eventos.

Pré-requisitos

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

Navegar até a instância de Gerenciamento de API

  1. No portal do Azure, pesquise e selecione os serviços de Gerenciamento de API:

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

  2. Na página 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 instância de Gerenciamento de API, selecione Implantação + infraestrutura e, em seguida, escolha Notificações para exibir as notificações disponíveis.

    Os eventos na lista a seguir podem ser configurados para enviar notificações.

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

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

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

    Captura de tela mostrando como adicionar destinatários de notificação no portal.

Configurar os 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 limite de cota se aproximando
  • Carta de boas-vindas do desenvolvedor
  • Notificação de alteração de email
  • Convidar usuário
  • Confirmação da conta nova de desenvolvedor
  • Nova assinatura ativada
  • Confirmação de alteração de senha
  • Solicitação de assinatura negada
  • Solicitação de assinatura recebida

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

Observação

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

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

  1. No menu da barra lateral, selecione Modelos de notificação. Captura de tela 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 email é enviado.
    • Para inserir um parâmetro, posicione o cursor onde desejar que ele seja colocado e selecione o nome do parâmetro.

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

Configurar as configurações de email

É possível modificar as configurações gerais de e-mail para notificações enviadas da instância de Gerenciamento de API. Você pode alterar o endereço de e-mail do administrador, o nome da organização que está enviando a notificação e o endereço de e-mail de origem.

Importante

Alterar o endereço de email de origem pode afetar a capacidade dos destinatários de receber emails. Confira as considerações na seção a seguir.

Para modificar as configurações de email:

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

  2. Selecione Configurações de email.

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

    • Email do administrador: o endereço de email 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 email 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 email do Gerenciamento de API no portal

  4. Clique em Salvar.

Considerações para alterar o endereço de email de origem

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

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

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

    • Autenticação SPF: o email pode não passar mais na autenticação SPF depois que você alterar o domínio de endereço de email de origem. Para garantir a autenticação SPF bem-sucedida e a entrega de email, crie o seguinte registro TXT no banco de dados DNS do domínio especificado no endereço de email. Por exemplo, se o endereço de email for noreply@contoso.com, entre em contato com o administrador de 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 email, o Gerenciamento de API requer a chave privada associada ao domínio do endereço de email 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 domínio mail.windowsazure.com.

Conteúdo relacionado

  • Last updated on