Konfigurace oznámení a šablon oznámení ve službě Azure API Management

  • Článek

PLATÍ PRO: Vývojář | Základní | Basic v2 | Standardní | Standard v2 | Premium

API Management poskytuje možnost konfigurovat e-mailová oznámení na míru pro konkrétní události a konfigurovat e-mailové šablona, které se používají ke komunikaci se správci a vývojáři instance API Management. Tento článek ukazuje, jak nakonfigurovat oznámení pro dostupné události a poskytuje přehled konfigurace e-mailových šablon používaných pro tyto události.

Požadavky

Pokud nemáte instanci služby API Management, proveďte následující rychlý start: Vytvořte instanci služby Azure API Management.

Přejít k instanci služby API Management

  1. Na webu Azure Portal vyhledejte a vyberte služby API Management.

    Výběr služeb API Management

  2. Na stránce služby API Management vyberte instanci služby API Management.

    Výběr instance služby API Management

Konfigurace oznámení na portálu

  1. V levém navigačním panelu instance služby API Management vyberte Oznámení a zobrazte dostupná oznámení.

    Pro oznámení je možné nakonfigurovat následující seznam událostí.

    • Žádosti o předplatné (vyžadující schválení) – Určeným příjemcům e-mailu a uživatelům se budou zobrazovat e-mailová oznámení o žádostech o odběr pro produkty vyžadující schválení.

    • Nová předplatná – Určeným příjemcům e-mailu a uživatelům se budou zobrazovat e-mailová oznámení o nových předplatných produktů.

    • Skrytá kopie – zadaná příjemci e-mailu a uživatelé dostanou kopie všech e-mailů odeslaných vývojářům e-mailem nevidomé.

    • Zpráva o zavření účtu – Zadaná příjemci e-mailu a uživatelé dostanou e-mailová oznámení při zavření účtu.

    • Blíží se limitu kvóty předplatného – Zadaná příjemci e-mailu a uživatelé dostanou e-mailová oznámení, když se využití předplatného blíží kvótě využití.

      Poznámka:

      Oznámení se aktivují pouze kvótou podle zásad předplatného . Kvóta podle zásad klíče negeneruje oznámení.

  2. Vyberte oznámení a zadejte jednu nebo více e-mailových adres, které mají být oznámeny:

    • Pokud chcete přidat e-mailovou adresu správce, vyberte + Přidat správce.
    • Pokud chcete přidat další e-mailovou adresu, vyberte + Přidat e-mail, zadejte e-mailovou adresu a vyberte Přidat.
    • Podle potřeby pokračujte v přidávání e-mailových adres.

    Snímek obrazovky znázorňující přidání příjemců oznámení na portálu

Konfigurace šablon oznámení

API Management poskytuje šablony oznámení pro e-mailové zprávy pro správu, které se automaticky odesílají vývojářům, když přistupují ke službě a používají ji. K dispozici jsou následující šablony oznámení:

  • Schválení odeslání galerie aplikací (zastaralé)
  • Dopis na rozloučenou vývojáře
  • Oznámení o omezení kvóty pro vývojáře
  • Uvítací dopis pro vývojáře
  • E-mailové oznámení o změně
  • Pozvat uživatele
  • Přidání nového komentáře k problému (zastaralé)
  • Potvrzení nového vývojářského účtu
  • Byl přijat nový problém (zastaralý)
  • Aktivované nové předplatné
  • Potvrzení změny hesla
  • Zamítnutá žádost o předplatné
  • Přijatá žádost o předplatné

Každá šablona e-mailu má předmět ve formátu prostého textu a definici textu ve formátu HTML. Každou položku je možné přizpůsobit podle potřeby.

Poznámka:

Obsah HTML v šabloně musí být správně formátovaný a musí dodržovat specifikaci XML. Znak   není povolený.

Zobrazení a konfigurace šablony oznámení na portálu:

  1. V nabídce vlevo vyberte šablony oznámení. Snímek obrazovky se šablonami oznámení na portálu

  2. Vyberte šablonu oznámení a nakonfigurujte ji pomocí editoru.

    Snímek obrazovky s editorem šablon oznámení na portálu

    • Seznam Parametry obsahuje seznam parametrů, které se při vložení do předmětu nebo textu nahradí určenou hodnotou při odeslání e-mailu.
    • Pokud chcete vložit parametr, umístěte kurzor na místo, kam chcete parametr přejít, a vyberte název parametru.

  3. Chcete-li uložit změny v šabloně e-mailu, vyberte Uložit nebo zrušte změny výběrem možnosti Zahodit.

Konfigurace nastavení e-mailu

Můžete upravit obecná e-mailová nastavení u oznámení, které se odesílají z vaší instance API Management. Můžete změnit e-mailovou adresu správce, název organizace odesílající oznámení a e-mailovou adresu, ze které se odesílají.

Důležité

Změna původní e-mailové adresy může ovlivnit schopnost příjemců přijímat e-maily. Podívejte se na důležité informace v následující části.

Úprava nastavení e-mailu:

  1. V nabídce vlevo vyberte šablony oznámení.
  2. Vyberte nastavení e-mailu.
  3. Na stránce Obecné nastavení e-mailu zadejte hodnoty pro:

    • Správa istrator e-mail – e-mailová adresa pro příjem všech systémových oznámení a dalších nakonfigurovaných oznámení

    • Název organizace – název vaší organizace pro použití na portálu pro vývojáře a oznámení

    • Původní e-mailová adresa – hodnota hlavičky From pro oznámení z instance služby API Management. SLUŽBA API Management odesílá oznámení jménem této původní adresy.

      Snímek obrazovky s nastavením e-mailu služby API Management na portálu

  4. Zvolte Uložit.

Důležité informace o změně původní e-mailové adresy

Příjemci e-mailových oznámení ze služby API Management můžou být ovlivněni při změně původní e-mailové adresy.

  • Změnit na Adresu Od - Když změníte původní e-mailovou adresu (například na no-reply@contoso.com), From bude noreply@contoso.com apimgmt-noreply@mail.windowsazure.comzáhlaví adresy . Důvodem je to, že služba API Management odesílá e-mail, a ne e-mailový server původní e-mailové adresy.

  • E-mail nastavený na složku Nevyžádaná pošta – Někteří příjemci nemusí dostávat e-mailová oznámení ze služby API Management nebo e-maily mohou být odeslány do složky Nevyžádaná pošta nebo Nevyžádaná pošta. K tomu může dojít v závislosti na nastavení ověřování E-mailu SPF nebo DKIM organizace:

    • Ověřování SPF – Po změně původní domény e-mailové adresy už nemusí e-mail předávat ověřování SPF. Pokud chcete zajistit úspěšné ověřování APF a doručení e-mailu, vytvořte následující záznam TXT v databázi DNS domény zadané v e-mailové adrese. Pokud je noreply@contoso.comnapříklad e-mailová adresa, obraťte se na správce contoso.com a přidejte následující záznam TXT: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • Ověřování DKIM – K vygenerování platného podpisu pro DKIM pro ověřování e-mailů vyžaduje služba API Management privátní klíč přidružený k doméně původní e-mailové adresy. V současné době ale není možné tento privátní klíč nahrát do služby API Management. Proto k přiřazení platného podpisu používá služba API Management privátní klíč přidružený k mail.windowsazure.com doméně.

Další kroky