Aracılığıyla paylaş


Azure API Management'ta bildirimleri ve bildirim şablonlarını yapılandırma

ŞUNLAR IÇIN GEÇERLIDIR: Geliştirici | Temel | Temel v2 | Standart | Standart v2 | Premium | Premium v2

Azure API Management, belirli olaylar için e-posta bildirimlerini yapılandırmanıza ve bir API Management örneğinin yöneticileri ve geliştiricileriyle iletişim kurmak için kullanılan e-posta şablonlarını yapılandırmanıza olanak tanır. Bu makalede, kullanılabilir olaylar için bildirimlerin nasıl yapılandırılacağını gösterir ve bu olaylar için kullanılan e-posta şablonlarını yapılandırmaya genel bir bakış sağlanır.

Önkoşullar

API Management hizmet örneğiniz yoksa şu hızlı başlangıcı tamamlayın: Azure API Management örneği oluşturma.

API Management örneğinize gidin

  1. Azureportalında API Management hizmetleriniarayıp seçin:

    Arama sonuçlarında API Management hizmetlerini gösteren ekran görüntüsü.

  2. API Management hizmetleri sayfasında API Management örneğinizi seçin:

    API Yönetimi hizmetleri sayfasında bir API Yönetimi örneğini gösteren ekran görüntüsü.

Azure portalında bildirimleri yapılandırma

  1. API Management örneğinizin kenar çubuğu menüsünde Dağıtım + altyapı'yı ve ardından Bildirimler'i seçerek kullanılabilir bildirimleri görüntüleyin.

    Bildirimler için aşağıdaki olay listesi yapılandırılabilir.

    • Abonelik istekleri (onay gerektirir): Belirtilen e-posta alıcıları ve kullanıcılar, onay gerektiren ürünler için abonelik istekleri hakkında e-posta bildirimleri alır.
    • Yeni abonelikler: Belirtilen e-posta alıcıları ve kullanıcıları yeni ürün abonelikleri hakkında e-posta bildirimleri alır.
    • Uygulama galerisi istekleri: Aşağıdaki e-posta alıcıları ve kullanıcıları, uygulama galerisine yeni uygulamalar gönderildiğinde e-posta bildirimleri alır.
    • Gizli Karbon Kopya: Belirtilen e-posta alıcıları ve kullanıcılar, geliştiricilere gönderilen tüm e-postaların gizli karbon kopyalarını alır.
    • Yeni sorun veya açıklama: Geliştirici portalında yeni bir sorun veya açıklama gönderildiğinde aşağıdaki e-posta alıcıları ve kullanıcıları e-posta bildirimleri alır.
    • Hesap iletisini kapat: Belirtilen e-posta alıcıları ve kullanıcılar, bir hesap kapatıldığında e-posta bildirimleri alır.
    • Abonelik kota sınırına yaklaşılıyor: Belirtilen e-posta alıcıları ve kullanıcılar, abonelik kullanımı kullanım kotasına yaklaştığında e-posta bildirimleri alır.
  2. Bir bildirim seçin ve bildirim almak için bir veya daha fazla e-posta adresi belirtin:

    • Yönetici e-posta adresini eklemek için + Yönetici ekle'yi seçin.
    • Başka bir e-posta adresi eklemek için + E-posta ekle'yi seçin, bir e-posta adresi girin ve Ekle'yi seçin.
    • Gerektiğinde e-posta adreslerini eklemeye devam edin.

    Portalda bildirim alıcılarının nasıl ekleneceğini gösteren ekran görüntüsü.

Bildirim şablonlarını yapılandırma

API Management, hizmete erişip kullandıklarında geliştiricilere otomatik olarak gönderilen yönetim e-posta iletileri için bildirim şablonları sağlar. Aşağıdaki bildirim şablonları sağlanır:

  • Geliştirici veda mektubu
  • Geliştirici kota sınırına yaklaşma bildirimi
  • Geliştirici karşılama mektubu
  • E-posta değişiklik bildirimi
  • Kullanıcı davet etme
  • Yeni geliştirici hesabı onayı
  • Yeni abonelik etkinleştirildi
  • Parola değişikliği onayı
  • Abonelik isteği reddedildi
  • Abonelik isteği alındı

Her e-posta şablonunun düz metin biçiminde bir konu satırı ve HTML biçiminde bir gövde tanımı vardır. Her öğe istenildiği gibi özelleştirilebilir.

Not

Şablondaki HTML içeriği iyi biçimlendirilmiş ve XML belirtimine uygun olmalıdır. "  karakterine izin verilmiyor."

Portalda bir bildirim şablonunu görüntülemek ve yapılandırmak için:

  1. Kenar çubuğu menüsünde Bildirim şablonları'nı seçin. Portaldaki bildirim şablonlarının ekran görüntüsü.

  2. Bir bildirim şablonu seçin ve düzenleyiciyi kullanarak şablonu yapılandırın.

    Portaldaki bildirim şablonu düzenleyicisinin ekran görüntüsü.

    • Parametreler listesi, konu veya gövdeye eklendiğinde, e-posta gönderildiğinde belirlenen değerle değiştirilen parametrelerin listesini içerir.
    • Parametre eklemek için, imleci parametrenin gitmesini istediğiniz yere getirin ve parametre adını seçin.
  3. Değişiklikleri e-posta şablonuna kaydetmek için Kaydet'i seçin veya At'ı seçerek değişiklikleri iptal edin.

E-posta ayarlarını yapılandırma

API Management örneğinizden gönderilen bildirimler için genel e-posta ayarlarını değiştirebilirsiniz. Yönetici e-posta adresini, bildirim gönderen kuruluşun adını ve kaynak e-posta adresini değiştirebilirsiniz.

Önemli

Kaynak e-posta adresinin değiştirilmesi, alıcıların e-posta alma yeteneğini etkileyebilir. Aşağıdaki bölümde dikkat edilmesi gereken noktalara bakın.

E-posta ayarlarını değiştirmek için:

  1. Kenar çubuğu menüsünde Bildirim şablonları'nı seçin.

  2. E-posta ayarları'nı seçin.

  3. Genel e-posta ayarları sayfasında, şu değerleri girin:

    • Yönetici e-postası: Tüm sistem bildirimlerini ve diğer yapılandırılmış bildirimleri almak için e-posta adresi.

    • Kuruluş adı: Geliştirici portalında ve bildirimlerde kullanılmak üzere kuruluşunuzun adı.

    • Kaynak e-posta adresi: API Management örneği bildirimleri için From üst bilgisinin değeri. API Management, bu kaynak adres adına bildirimler gönderir.

      Portaldaki API Management e-posta ayarlarının ekran görüntüsü

  4. Kaydet'i seçin.

Kaynak e-posta adresini değiştirmeyle ilgili dikkat edilmesi gerekenler

API Management'tan gelen e-posta bildirimlerinin alıcıları, kaynak e-posta adresini değiştirdiğinizde etkilenebilir.

  • Kimden adresini değiştirin: Kaynak e-posta adresini (örneğin, no-reply@contoso.com olarak) değiştirdiğinizde Kimden adresi üst bilgisi noreply@contoso.com apimgmt-noreply@mail.windowsazure.com olur. Bunun nedeni, e-postanın kaynak e-posta adresinin e-posta sunucusu değil API Management tarafından gönderilmesidir.

  • Gereksiz veya istenmeyen posta klasörüne gönderilen e-posta: Bazı alıcılar API Management'tan e-posta bildirimlerini almayabilir veya e-postalar gereksiz veya istenmeyen posta klasörüne gönderilebilir. Bu, kuruluşun SPF veya DKIM e-posta kimlik doğrulama ayarlarına bağlı olarak oluşabilir:

    • SPF kimlik doğrulaması: Kaynak e-posta adresi etki alanını değiştirdikten sonra e-posta artık SPF kimlik doğrulamasını geçemeyebilir. SPF kimlik doğrulamasının başarılı olmasını ve e-postanın teslim edilmesini sağlamak için, e-posta adresinde belirtilen etki alanının DNS veritabanında aşağıdaki TXT kaydını oluşturun. Örneğin, e-posta adresiniz noreply@contoso.com ise, şu TXT kaydını ekletmek için contoso.com yöneticisine başvurun: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • DKIM kimlik doğrulaması: E-posta kimlik doğrulaması için DKIM için geçerli bir imza oluşturmak için API Management, kaynak e-posta adresinin etki alanıyla ilişkili özel anahtarı gerektirir. Ancak şu anda bu özel anahtarı API Management'a yüklemek mümkün değildir. Bu nedenle API Management, geçerli bir imza atamak için etki alanıyla mail.windowsazure.com ilişkili özel anahtarı kullanır.