Meldingen en meldingssjablonen configureren in Azure API Management

Artikel
04/04/2024

API Management biedt de mogelijkheid om e-mailmeldingen voor specifieke gebeurtenissen te configureren en de e-mailsjablonen te configureren die worden gebruikt om te communiceren met de beheerders en ontwikkelaars van een API Management-exemplaar. Dit artikel laat zien hoe u meldingen configureert voor de beschikbare gebeurtenissen en biedt een overzicht van het configureren van de e-mailsjablonen die voor deze gebeurtenissen worden gebruikt.

Vereisten

Als u geen EXEMPLAAR van de API Management-service hebt, voltooit u de volgende quickstart: Een Azure API Management-exemplaar maken.

Ga naar uw API Management-exemplaar

Zoek en selecteer API Management-services in Azure Portal.
Selecteer uw API Management-exemplaar op de pagina API Management-services.

Meldingen configureren in de portal

Selecteer in de linkernavigatiebalk van uw API Management-exemplaar Meldingen om de beschikbare meldingen weer te geven.

De volgende lijst met gebeurtenissen kan worden geconfigureerd voor meldingen.
- Abonnementsaanvragen (waarvoor goedkeuring is vereist): de opgegeven e-mailontvangers en gebruikers ontvangen e-mailmeldingen over abonnementsaanvragen voor producten waarvoor goedkeuring is vereist.
- Nieuwe abonnementen : de opgegeven e-mailontvangers en gebruikers ontvangen e-mailmeldingen over nieuwe productabonnementen.
- BCC : de opgegeven e-mailontvangers en gebruikers ontvangen e-mailblind carbon kopieën van alle e-mailberichten die naar ontwikkelaars worden verzonden.
- Accountbericht sluiten: de opgegeven e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer een account wordt gesloten.
- Limiet voor abonnementsquotum naderen: de opgegeven e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer het abonnementsgebruik dicht bij het gebruiksquotum komt.
Selecteer een melding en geef een of meer e-mailadressen op die moeten worden gewaarschuwd:
- Als u het e-mailadres van de beheerder wilt toevoegen, selecteert u + Beheerder toevoegen.
- Als u nog een e-mailadres wilt toevoegen, selecteert u + E-mailadres toevoegen, voert u een e-mailadres in en selecteert u Toevoegen.
- Ga zo nodig door met het toevoegen van e-mailadressen.

Meldingssjablonen configureren

API Management biedt meldingssjablonen voor de beheer-e-mailberichten die automatisch naar ontwikkelaars worden verzonden wanneer ze de service openen en gebruiken. De volgende meldingssjablonen zijn beschikbaar:

Goedgekeurde inzending in de toepassingsgalerie (afgeschaft)
Afscheidsbrief voor ontwikkelaars
Quotumlimiet voor ontwikkelaars nadert melding
Welkomstbrief voor ontwikkelaars
Melding voor e-mailwijziging
Gebruiker uitnodigen
Nieuwe opmerking toegevoegd aan een probleem (afgeschaft)
Bevestiging van nieuwe ontwikkelaarsaccount
Nieuw probleem ontvangen (afgeschaft)
Nieuw abonnement geactiveerd
Bevestiging van wachtwoordwijziging
Abonnementsaanvraag geweigerd
Ontvangen abonnementsaanvraag

Elke e-mailsjabloon heeft een onderwerp in tekst zonder opmaak en een hoofdtekstdefinitie in HTML-indeling. Elk item kan naar wens worden aangepast.

Notitie

HTML-inhoud in een sjabloon moet goed zijn opgemaakt en voldoen aan de XML-specificatie. Het   teken is niet toegestaan.

Een meldingssjabloon weergeven en configureren in de portal:

Selecteer meldingssjablonen in het linkermenu.
Selecteer een meldingssjabloon en configureer de sjabloon met behulp van de editor.
- De lijst Parameters bevat een lijst met parameters, die worden ingevoegd in het onderwerp of de hoofdtekst, worden vervangen door de aangewezen waarde wanneer het e-mailbericht wordt verzonden.
- Als u een parameter wilt invoegen, plaatst u de cursor op de plaats waar u de parameter wilt plaatsen en selecteert u de parameternaam.
Als u de wijzigingen in de e-mailsjabloon wilt opslaan, selecteert u Opslaan of als u de wijzigingen wilt annuleren, selecteert u Verwijderen.

E-mailinstellingen configureren

U kunt algemene e-mailinstellingen wijzigen voor meldingen die worden verzonden vanuit uw API Management-exemplaar. U kunt het e-mailadres van de beheerder, de naam van de organisatie die meldingen verzendt en het e-mailadres van de afzender wijzigen.

Belangrijk

Het wijzigen van het oorspronkelijke e-mailadres kan van invloed zijn op de mogelijkheid van geadresseerden om e-mail te ontvangen. Zie de overwegingen in de volgende sectie.

E-mailinstellingen wijzigen:

Selecteer meldingssjablonen in het linkermenu.
Selecteer E-mailinstellingen.
Voer op de pagina Algemene e-mailinstellingen waarden in voor:
- E-mailadres van beheerder: het e-mailadres voor het ontvangen van alle systeemmeldingen en andere geconfigureerde meldingen
- Organisatienaam : de naam van uw organisatie voor gebruik in de ontwikkelaarsportal en meldingen
- Oorspronkelijk e-mailadres : de waarde van de From header voor meldingen van het API Management-exemplaar. API Management verzendt meldingen namens dit oorspronkelijke adres.
Selecteer Opslaan.

Overwegingen voor het wijzigen van het oorspronkelijke e-mailadres

Ontvangers van e-mailmeldingen van API Management kunnen worden beïnvloed wanneer u het oorspronkelijke e-mailadres wijzigt.

Wijzigen in Van-adres - Wanneer u het oorspronkelijke e-mailadres wijzigt (bijvoorbeeld in no-reply@contoso.com), wordt de From adreskop weergegeven noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Dit komt doordat het e-mailbericht wordt verzonden door API Management en niet de e-mailserver van het oorspronkelijke e-mailadres.
E-mail die is ingesteld op de map Ongewenste e-mail of spam. Sommige geadresseerden ontvangen mogelijk niet de e-mailmeldingen van API Management of e-mailberichten worden verzonden naar de map Ongewenste e-mail of Ongewenste e-mail. Dit kan gebeuren, afhankelijk van de SPF- of DKIM-e-mailverificatie-instellingen van de organisatie:
- SPF-verificatie - E-mail geeft mogelijk geen SPF-verificatie meer door nadat u het oorspronkelijke e-mailadresdomein hebt gewijzigd. Maak de volgende TXT-record in de DNS-database van het domein dat is opgegeven in het e-mailadres om een geslaagde SPF-verificatie en -bezorging van e-mail te garanderen. Als het e-mailadres bijvoorbeeld is noreply@contoso.com, neemt u contact op met de beheerder van contoso.com om de volgende TXT-record toe te voegen: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"
- DKIM-verificatie : voor het genereren van een geldige handtekening voor DKIM voor e-mailverificatie vereist API Management de persoonlijke sleutel die is gekoppeld aan het domein van het oorspronkelijke e-mailadres. Het is momenteel echter niet mogelijk om deze persoonlijke sleutel te uploaden in API Management. Om een geldige handtekening toe te wijzen, gebruikt API Management daarom de persoonlijke sleutel die aan het mail.windowsazure.com domein is gekoppeld.

Share via