Bildirim şablonlarını kullanarak bildirim oluşturma

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Bildirim şablonları nedir?

Para kazanma, çeşitli etkinlik bildirimi türleri için örnek metin tanımlayan bir dizi şablon sağlar. Bu şablonların herhangi birini özelleştirerek şunları yapabilirsiniz:

• Tüm geliştiricileri yeni ürünler, yeni H&S sürümleri veya yeni fiyat planları gibi etkinlikler hakkında bilgilendirin.
• Etkilenen geliştiricileri, revize edilmiş bir fiyat planı gibi etkinlikler hakkında bilgilendirin.
• Bir geliştiricinin hesap için kaydolması veya bir ücret planına kaydolması gibi geliştiriciyle ilgili etkinlikler hakkında bir API sağlayıcıyı bilgilendirin.
• Tüm şirket yöneticilerini belirli bir etkinlik hakkında bilgilendirin.

Alternatif olarak, HTTP geri çağırma işleyicisini tanımlayan bir webhook oluşturabilir ve ardından Webhook'ları kullanarak bildirimleri ayarlama bölümünde açıklandığı şekilde webhook'u tetikleyen koşulu yapılandırabilirsiniz.

Bildirimler sayfasını keşfetme

Aşağıda açıklandığı şekilde Bildirimler sayfasına erişin.

Düzenleme bildirimleri

Kullanıcı arayüzünü kullanarak bir bildirimi düzenlemek için:

1. Bildirimler sayfasına erişin.
2. Ayrıntılarını genişletmek için düzenlemek istediğiniz bildirimin yanındaki simgesini tıklayın.
3. Konu, Gövde ve Alıcı (varsa) alanlarını gerektiği gibi düzenleyin.

   Bildirim şablonunda belirtilebilen değişkenler hakkında bilgi edinmek için Bildirim şablonlarında değişkenleri kullanma başlıklı makaleyi inceleyin.

   Her kategorideki bildirimleri düzenleme hakkında daha fazla bilgi için aşağıdaki bölümlere bakın:

   • Tüm Geliştiricileri Bilgilendirmek İçin Bildirimleri Düzenleme
   • Etkilenen Geliştiricileri Bilgilendirmek İçin Bildirimleri Düzenleme
   • Bildirimleri düzenleyerek API sağlayıcılarını bilgilendirme
4. Yanındaki onay kutusunu işaretleyerek bir bildirimi etkinleştirin.
5. Diğer bildirimleri düzenlemek için 2-4 arasındaki adımları tekrarlayın.
6. Tüm değişiklikleri kaydetmek için Kaydet'i tıklayın.

Bildirimlerin kaydedildiğini onaylayan bir mesaj gösterilir. Kaydetme işlemi birkaç dakika sürebilir.

Tüm Geliştiricileri Bilgilendirmek İçin Bildirimleri Düzenleme

Tüm Geliştiricileri Bilgilendir bölümünde seçtiğiniz etkinlik türleriyle ilgili bildirimler tüm geliştiricilere gönderilir.

Bildirimler, günün sonunda çalışacak şekilde planlanır. Bildirimler gönderildikten sonra etkinlik onay kutularının işareti otomatik olarak kaldırılır. İlişkili etkinlik türleri için bildirim planlamak üzere bunları tekrar seçmeniz gerekir.

Aşağıdaki tabloda, Tüm Geliştiricileri Bilgilendir bölümündeki etkinlik türlerine göre bildirimler listelenmektedir. Daha fazla bilgi için Kullanıcı arayüzünü kullanarak bildirimleri düzenleme başlıklı makaleyi inceleyin.

Etkilenen Geliştiricileri Bilgilendirmek İçin Bildirimleri Düzenleme

Etkilenen Geliştiricileri Bildir bölümünde seçtiğiniz etkinlik türleriyle ilgili bildirimler yalnızca bu etkinlik türlerinden etkilenen geliştiricilere gönderilir. Örneğin, Revize edilmiş fiyat planı etkinliğini seçerseniz yalnızca fiyat planını kabul eden geliştiricilere bildirim gönderilir.

Aşağıdaki tabloda, Etkilenen Geliştiricileri Bilgilendir bölümündeki etkinlik türlerine göre bildirimler listelenmektedir. Daha fazla bilgi için Kullanıcı arayüzünü kullanarak bildirimleri düzenleme başlıklı makaleyi inceleyin.

Bildirimleri düzenleyerek API sağlayıcılarını bilgilendirme

API Sağlayıcıyı Bilgilendir bölümünde seçtiğiniz etkinlik türleriyle ilgili bildirimler, belirttiğiniz API sağlayıcıya gönderilir.

Aşağıdaki tabloda, Notify API Sağlayıcı bölümündeki etkinlik türlerine göre bildirimler listelenmektedir. Daha fazla bilgi için Kullanıcı arayüzünü kullanarak bildirimleri düzenleme başlıklı makaleyi inceleyin.

Bildirimleri etkinleştirme veya devre dışı bırakma

Kullanıcı arayüzünü kullanarak bir bildirimi etkinleştirmek veya devre dışı bırakmak için:

1. Bildirimler sayfasına erişin.
2. Yanındaki onay kutusunu işaretleyerek veya kutunun işaretini kaldırarak bildirimi etkinleştirin ya da devre dışı bırakın.
3. Tüm değişiklikleri kaydetmek için Kaydet'i tıklayın.

Kaydetme işlemi birkaç dakika sürebilir. Bildirimlerin kaydedildiğini onaylayan bir mesaj gösterilir.

API'yi kullanarak şablonlarla bildirim ayarlama

Aşağıdaki bölümlerde açıklandığı gibi API'yi kullanarak bildirimleri ayarlayın.

API'yi kullanarak bildirim şablonlarını yönetme

Bildirim şablonlarını aşağıdaki bölümlerde açıklandığı şekilde API'yi kullanarak yönetin:

• API'yi kullanarak tüm bildirim şablonlarını görüntüleme
• API'yi kullanarak bildirim şablonunu görüntüleme
• API kullanarak bildirim şablonunu düzenleme

API'yi kullanarak tüm bildirim şablonlarını görüntüleme

Para kazanma özelliğinin sağladığı tüm bildirim şablonlarını /mint/organizations/{org_name}/notification-email-templates adresine GET isteği göndererek listeleyebilirsiniz. Örneğin:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

Örneğin, aşağıda geliştiricileri yeni bir API ürününün kullanılabilirliği konusunda bilgilendiren bir etkinlik şablonu verilmiştir:

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

API'yi kullanarak bildirim şablonunu görüntüleme

/mint/organizations/{org_name}/notification-email-templates/{template_id} adresine bir GET isteği göndererek bildirim şablonunu görüntüleyin. Burada {template_id}, şablonun kimliğidir. Örneğin:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

Şablonlardaki $ ile başlayan öğeler değişkendir. Daha fazla bilgi için Bildirim şablonlarında değişkenleri kullanma başlıklı makaleyi inceleyin. Bildirimdeki değişkenlerin aşağıdaki değerlere eşit olduğunu varsayalım:

• ${developer.legalName}.XYZ company
• ${developer.name}.DEV1
• ${QUOTA_TYPE}.Transactions
• ${PERCENT}.90%
• ${QUOTA_UNIT}.Calls
• ${QUOTA_LIMIT}.100
• ${ratePlan.monetizationPackage.products.name}.X
• ${EXPIRY_DATE}.2016-09-30

Şablon tarafından sağlanan bildirim mesajı şu şekilde olur:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

API'yi kullanarak bildirim şablonunu düzenleme

/nint/organizations/{org_name}/notification-email-templates/{template_id} adresine PUT isteği göndererek bildirim şablonunu düzenleyin. İstek gövdesinde şablonun değiştirilmiş içeriğini sağlayın.

Bildirim şablonundaki mesajı özelleştirirken bir veya daha fazla değişken ekleyebilirsiniz. Daha fazla bilgi için Bildirim şablonlarında değişken kullanma başlıklı makaleyi inceleyin.

Örneğin, aşağıdaki istek yeni bir API ürünü bildiriminin içeriğini düzenler:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

API'yi kullanarak bildirim koşullarını ve işlemlerini yönetme

Bildirim koşullarını ve işlemlerini aşağıdaki bölümlerde açıklandığı şekilde API'yi kullanarak yönetin.

• API'yi kullanarak bildirim koşulu ve işlemi oluşturma
• API'yi kullanarak bildirim koşulunu ve işlemini görüntüleme
• API'yi kullanarak bildirim koşulu ve işlemi düzenleme
• API'yi kullanarak bildirim koşulunu ve işlemini silme

API'yi kullanarak bildirim koşulu ve işlemi oluşturma

/mint/organizations/{org_name}/notification-conditions adresine bir POST isteği göndererek otomatik bildirimle sonuçlanan bir bildirim koşulu ve işlemi oluşturun.

İsteği gönderirken istek gövdesinde bildirime neden olan koşulu ve koşul karşılandığında yapılacak işlemleri (ör. bildirim e-postası gönderme) belirtin.

Bir veya daha fazla özellik değeri belirterek bildirim koşulunun ayrıntılarını tanımlarsınız. Özelliklerin listesi için Bildirim koşulları için yapılandırma özellikleri başlıklı makaleyi inceleyin. Etkinlik bildiriminde, yeni bir ürün yayınlandığında koşul tetiklenebilir.

actions öğesini tanımlarken geçerli bildirim şablonuna referans verin. İşlem listesi için Bildirim işlemleri için yapılandırma özellikleri başlıklı makaleyi inceleyin.

Örneğin, aşağıdaki istekte özelliğin NEW_PRODUCT ve PUBLISHED özelliğinin değerinin true olduğu durumlarda, 01191bf9-5fdd-45bf-8130-3f024694e63 kimlikli şablonda (bu, DEFAULT_NEW_PRODUCT_TEMPLATE) bildirim gönderilmesi gerektiği belirtiliyor.

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

API'yi kullanarak bildirim koşulunu ve işlemini görüntüleme

organizations/{org_name}/notification-conditions/{condition_Id} adresine bir GET isteği göndererek bildirim koşulunu ve işlemini görüntüleyin. Burada {condition_Id}, koşulun kimliğidir. Kimlik, bildirim koşulunu oluşturduğunuzda döndürülür. Örneğin:

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

Aşağıda, yanıta dair bir örnek verilmiştir:

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

API'yi kullanarak bildirim koşulu ve işlemi düzenleme

organizations/{org_name}/notification-conditions/{condition_Id} adresine POST isteği göndererek bildirim koşulunu ve işlemini düzenleyin. Burada {condition_Id}, koşulun kimliğidir. Kimlik, bildirim koşulunu oluşturduğunuzda döndürülür. İsteği gönderirken istek gövdesinde bildirim koşulunda veya işleminde yapmak istediğiniz değişiklikleri belirtin.

Örneğin:

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

API'yi kullanarak bildirim koşulunu ve işlemini silme

organizations/{org_name}notification-conditions/{condition_Id} adresine bir DELETE isteği göndererek bildirim koşulunu silin. Örneğin:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

Bildirim koşulları için yapılandırma özellikleri

API kullanılırken bildirim koşulları için aşağıdaki yapılandırma özellikleri kullanılabilir.

Bildirim işlemleri için yapılandırma özellikleri

API kullanılırken bildirim işlemleri için aşağıdaki yapılandırma özellikleri kullanılabilir.

Bildirim şablonlarında değişkenleri kullanma

Bildirim şablonundaki mesajı düzenlerken İşlem nesnesinde döndürülen değerleri temsil etmek için Spring Expression Language (SpEL) kullanarak bir veya daha fazla değişken ekleyebilirsiniz.

Aşağıdaki tabloda, en çok tercih edilen bildirim şablonu değişkenleri özetlenmektedir.

Yanıt e-posta adresinizi özelleştirme

Para kazanma için şirketlere ve geliştiricilere gönderilen e-posta bildirimlerinde kullanılmak üzere varsayılan bir noreply@apigee.com adresi yapılandırılır. Kuruluşunuz için özel bir yanıt adı ve adresi yapılandırmak üzere Apigee Destek Ekibi ile iletişime geçin.