Share via

Så här konfigurerar du aviseringar och meddelandemallar i Azure API Management

  • Artikel

GÄLLER FÖR: Utvecklare | Grundläggande | Basic v2 | Standard | Standard v2 | Premium

API Management ger möjlighet att konfigurera e-postaviseringar för specifika händelser och konfigurera de e-postmallar som används för att kommunicera med administratörer och utvecklare av en API Management instans. Den här artikeln visar hur du konfigurerar meddelanden för tillgängliga händelser och ger en översikt över hur du konfigurerar de e-postmallar som används för dessa händelser.

Förutsättningar

Om du inte har någon API Management-tjänstinstans slutför du följande snabbstart: Skapa en Azure API Management-instans.

Gå till API Management-instansen

  1. I Azure-portalen söker du efter och väljer API Management-tjänster.

    Välj API Management-tjänster

  2. På sidan API Management-tjänster väljer du din API Management-instans.

    Välj din API Management-instans

Konfigurera meddelanden i portalen

  1. I det vänstra navigeringsfältet för DIN API Management-instans väljer du Meddelanden för att visa de tillgängliga meddelandena.

    Följande lista över händelser kan konfigureras för meddelanden.

    • Prenumerationsbegäranden (kräver godkännande) – De angivna e-postmottagarna och användarna får e-postaviseringar om prenumerationsbegäranden för produkter som kräver godkännande.

    • Nya prenumerationer – De angivna e-postmottagarna och användarna får e-postaviseringar om nya produktprenumerationer.

    • Hemlig kopia – De angivna e-postmottagarna och användarna får e-postblinda kopior av alla e-postmeddelanden som skickas till utvecklare.

    • Stäng kontomeddelande – De angivna e-postmottagarna och användarna får e-postmeddelanden när ett konto stängs.

    • Närmar sig prenumerationskvotgräns – De angivna e-postmottagarna och användarna får e-postaviseringar när prenumerationsanvändningen närmar sig användningskvoten.

      Kommentar

      Meddelanden utlöses endast av kvoten av prenumerationsprincipen . Kvoten efter nyckelprincip genererar inte meddelanden.

  2. Välj ett meddelande och ange en eller flera e-postadresser som ska meddelas:

    • Om du vill lägga till administratörens e-postadress väljer du + Lägg till administratör.
    • Om du vill lägga till ytterligare en e-postadress väljer du + Lägg till e-post, anger en e-postadress och väljer Lägg till.
    • Fortsätt att lägga till e-postadresser efter behov.

    Skärmbild som visar hur du lägger till meddelandemottagare i portalen

Konfigurera meddelandemallar

API Management tillhandahåller meddelandemallar för administrativa e-postmeddelanden som skickas automatiskt till utvecklare när de kommer åt och använder tjänsten. Följande meddelandemallar tillhandahålls:

  • Sändning av programgalleri godkänd (inaktuell)
  • Utvecklarens avskedsbrev
  • Meddelande om kvotbegränsning för utvecklare närmar sig
  • Välkomstbrev för utvecklare
  • Meddelande om ändring av e-post
  • Bjud in användare
  • Ny kommentar har lagts till i ett problem (inaktuellt)
  • Bekräftelse av nytt utvecklarkonto
  • Nytt problem har tagits emot (inaktuellt)
  • Ny prenumeration aktiverad
  • Bekräftelse av lösenordsändring
  • Prenumerationsbegäran nekades
  • Prenumerationsbegäran har tagits emot

Varje e-postmall har ett ämne i oformaterad text och en brödtextdefinition i HTML-format. Varje objekt kan anpassas efter behov.

Kommentar

HTML-innehåll i en mall måste vara välformat och följa XML-specifikationen. Tecknet   är inte tillåtet.

Så här visar och konfigurerar du en meddelandemall i portalen:

  1. I den vänstra menyn väljer du Meddelandemallar. Skärmbild av meddelandemallar i portalen

  2. Välj en aviseringsmall och konfigurera mallen med hjälp av redigeraren.

    Skärmbild av meddelandemallsredigeraren i portalen

    • Listan Parametrar innehåller en lista med parametrar som när den infogas i ämnet eller brödtexten ersätts med det angivna värdet när e-postmeddelandet skickas.
    • Om du vill infoga en parameter placerar du markören där du vill att parametern ska gå och väljer parameternamnet.

  3. Spara ändringarna i e-postmallen genom att välja Spara eller avbryta ändringarna genom att välja Ignorera.

Konfigurera e-postinställningar

Du kan ändra allmänna e-postinställningar för meddelanden som skickas från din API Management instans. Du kan ändra administratörens e-postadress, namnet på organisationen som skickar meddelanden och den ursprungliga e-postadressen.

Viktigt!

Om du ändrar den ursprungliga e-postadressen kan det påverka mottagarnas möjlighet att ta emot e-post. Se övervägandena i följande avsnitt.

Så här ändrar du e-postinställningarna:

  1. I den vänstra menyn väljer du Meddelandemallar.
  2. Välj E-postinställningar.
  3. På sidan Allmänna e-postinställningar anger du värden för:

    • Administratörs-e-post – e-postadressen för att ta emot alla systemaviseringar och andra konfigurerade meddelanden

    • Organisationsnamn – namnet på din organisation för användning i utvecklarportalen och meddelanden

    • Ursprunglig e-postadress – värdet för From huvudet för meddelanden från API Management-instansen. API Management skickar meddelanden för den här ursprungsadressen.

      Skärmbild av e-postinställningar för API Management i portalen

  4. Välj Spara.

Överväganden för att ändra den ursprungliga e-postadressen

Mottagare av e-postaviseringar från API Management kan påverkas när du ändrar den ursprungliga e-postadressen.

  • Ändra till Från-adress – När du ändrar den ursprungliga e-postadressen (till exempel till no-reply@contoso.com) blir noreply@contoso.com apimgmt-noreply@mail.windowsazure.comadressrubriken From . Det beror på att e-postmeddelandet skickas av API Management och inte e-postservern för den ursprungliga e-postadressen.

  • E-post inställd på skräppostmapp – Vissa mottagare kanske inte får e-postaviseringar från API Management eller så skickas e-postmeddelanden till mappen Skräppost eller Skräppost. Detta kan inträffa beroende på organisationens inställningar för SPF- eller DKIM-e-postautentisering:

    • SPF-autentisering – E-post kanske inte längre klarar SPF-autentisering när du har ändrat den ursprungliga e-postadressdomänen. För att säkerställa lyckad SPF-autentisering och leverans av e-post skapar du följande TXT-post i DNS-databasen för domänen som anges i e-postadressen. Om e-postadressen till exempel är noreply@contoso.comkontaktar du administratören för contoso.com för att lägga till följande TXT-post: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • DKIM-autentisering – För att generera en giltig signatur för DKIM för e-postautentisering kräver API Management den privata nyckeln som är associerad med domänen för den ursprungliga e-postadressen. Det går dock för närvarande inte att ladda upp den här privata nyckeln i API Management. För att tilldela en giltig signatur använder API Management därför den privata nyckel som är associerad med domänen mail.windowsazure.com .

Nästa steg