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

  • Artigo

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

Gestão de API fornece a capacidade de configurar notificações por e-mail para eventos específicos e configurar os modelos de e-mail utilizados para comunicar com os administradores e programadores de uma instância Gestão 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 Gerenciamento de API.

    Selecionar serviços de gerenciamento de API

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

    Selecione sua instância de Gerenciamento de API

Configurar notificações no portal

  1. Na navegação à esquerda da instância de Gerenciamento de API, selecione 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 receberão 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 receberão notificações por e-mail sobre novas assinaturas de produtos.
    • BCC - Os destinatários e usuários de e-mail especificados receberão cópias ocultas de todos os e-mails enviados aos desenvolvedores.
    • Mensagem de fechamento de conta - Os destinatários e usuários de e-mail especificados receberão notificações por e-mail quando uma conta for fechada.
    • Aproximando-se do limite de cota de assinatura - Os destinatários e usuários de e-mail especificados receberão notificações por e-mail quando o uso da assinatura se aproximar 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:

  • Submissão da galeria de candidaturas aprovada (preterida)
  • Carta de despedida do desenvolvedor
  • Limite de cota de desenvolvedor se aproximando da notificação
  • Carta de boas-vindas do desenvolvedor
  • Notificação de alteração de e-mail
  • Convidar utilizador
  • Novo comentário adicionado a um problema (preterido)
  • Confirmação da nova conta de programador
  • Nova edição recebida (preterida)
  • 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 e-mail tem um assunto em texto simples 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   personagem não é permitido.

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

  1. No menu à esquerda, 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, serão substituídos pelo valor designado quando o e-mail for 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, para cancelar as alterações, selecione Descartar.

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 à esquerda, 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 From cabeçalho 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 para o endereço De - Quando você altera o endereço de e-mail de origem (por exemplo, para no-reply@contoso.com), o cabeçalho do From endereço 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 definido como Lixo ou pasta de 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 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.

Próximos passos