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

  • Artigo

APLICA-SE A: Desenvolvedor | Básico | Básico v2 | Standard | Standard v2 | Premium

O Gerenciamento de API possibilita configurar notificações de email para eventos específicos e modelos de email que são 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 serviços de Gerenciamento de API.

    Selecione Serviços de Gerenciamento de API

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

    Selecione a sua instância de Gerenciamento de API

Configurar notificações no portal

  1. No painel de navegação esquerdo da instância de Gerenciamento de API, selecione 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 (que exigem aprovação) - Os usuários e destinatários de email especificados receberão notificações por email sobre solicitações de assinaturas de produtos que exigem aprovação.

    • Novas assinaturas - Os usuários e destinatários de email especificados receberão notificações por email sobre novas assinaturas de produtos.

    • CCO - Os usuários e destinatários de email especificados receberão cópias ocultas de todos os emails enviados a desenvolvedores.

    • Mensagem de conta encerrada - Os usuários e destinatários de email especificados receberão notificações por email quando uma conta for encerrada.

    • Limite de cota de assinatura se aproximando - Os usuários e destinatários de email especificados receberão notificações por email quando o uso de assinaturas estiver se aproximando da cota.

      Observação

      As notificações são disparadas apenas pela política de cota por assinatura. A política de cota por chave não gera notificações.

  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 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:

  • Envio à galeria de aplicativos aprovado (preterido)
  • 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
  • Novo comentário adicionado a um problema (preterido)
  • Confirmação da conta nova de desenvolvedor
  • Novo problema recebido (preterido)
  • 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 um assunto em texto sem formatação e uma definição de corpo em 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 à esquerda, 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 modelos de notificação no portal

    • A lista Parâmetros contém parâmetros que, quando inseridos no assunto ou corpo, serão substituídos pelo valor designado quando o email for 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 as alterações feitas no modelo de email, clique em Salvar ou, para cancelar as alterações, clique em Descartar.

Definir 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 à esquerda, selecione Modelos de notificação.
  2. Selecione Configurações de email.
  3. Na página 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 - Especifique o nome da sua organização para uso nas notificações e no portal do desenvolvedor

    • Endereço de email de origem – o valor do cabeçalho From 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. Selecione 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 para endereço De – quando você alterar o endereço de email de origem (por exemplo, para no-reply@contoso.com), o cabeçalho do endereço From 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 definido 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 deixar de passar pela autenticação SPF depois que você alterar o domínio do 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 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 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.

Próximas etapas