Bildirim şablonlarını kullanarak bildirim oluşturma

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Bildirim şablonları nedir?

Para kazanma, çeşitli etkinlik türleri için örnek metin tanımlayan bir dizi şablon sunar. bildirimleri etkinleştirebilirsiniz. Bu şablonlardan herhangi birini özelleştirebilirsiniz:

• Yeni ürünler, Hüküm ve Koşullar'ın yeni versiyonları gibi etkinlikler hakkında tüm geliştiricileri bilgilendir ücret planları.
• Etkilenen geliştiricileri, revize edilmiş ücret planı gibi etkinlikler hakkında bilgilendirin.
• Bir API sağlayıcısını, geliştiriciyle ilgili etkinlikler hakkında (ör. bir geliştiricinin kaydolması) bilgilendirin ücret planına kaydolduğunda gelir artışı elde edebilir.
• Belirli bir etkinlikle ilgili olarak tüm şirket yöneticilerini bilgilendirebilirsiniz.

Alternatif olarak HTTP geri arama işleyiciyi tanımlayan bir webhook oluşturup daha sonra webhook'lar gibi).

Bildirimler sayfasını keşfetme

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

Bildirimleri düzenleme

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 şablonu içinde belirtilebilecek değişkenler hakkında bilgi için Bildirim şablonlarında değişkenleri kullanma konusuna bakın.

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

   • Tüm Geliştiricileri Bilgilendirmek için bildirimleri düzenleme
   • Etkilenen Geliştiricilere Bilgilendirmek için bildirimleri düzenleme
   • API Sağlayıcılarını Bilgilendirmek için bildirimleri düzenleme
4. Bir bildirimi etkinleştirmek için yanındaki onay kutusunu işaretleyin.
5. Diğer bildirimleri düzenlemek için 2-4. adımları tekrarlayın.
6. Tüm değişiklikleri kaydetmek için Kaydet'i tıklayın.

Bildirimlerin gerçekleştirildiğini onaylamak için kaydedildi. Kaydetme işlemi birkaç dakika sürebilir.

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

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

Bildirimler gün sonunda çalışacak şekilde planlandı. Bildirimler etkinlik onay kutuları otomatik olarak temizlenir. Planlamak için bu kanalları tekrar seçmeniz gerekir bildirimleri alabilir.

Aşağıdaki tabloda, Tüm Geliştiricileri Bildir bölümünde belirtilen etkinlik türlerine göre bildirimler listelenmiştir. Daha fazla bilgi için Kullanıcı arayüzünü kullanarak bildirimleri düzenleme konusuna bakın.

Etkilenen Geliştiricilere Bilgilendirmek için bildirimleri düzenleme

Etkilenenleri Bildirme Geliştiriciler bölümü yalnızca bu tür etkinliklerden etkilenen geliştiricilere gönderilir. Örneğin, Düzenlenen ücret planı etkinliğini seçerseniz yalnızca ücret planını kabul eden geliştiricilerle.

Aşağıdaki tabloda, Etkilenen Geliştiricileri Bilgilendirme bölümündeki etkinlik türlerine dayalı bildirimler listelenmiştir. Daha fazla bilgi için Kullanıcı arayüzünü kullanarak bildirimleri düzenleme konusuna bakın.

API Sağlayıcılarını Bilgilendirmek için bildirimleri düzenleme

Bildir API Sağlayıcısı bölümünde seçtiğiniz etkinlik türleri için bildirimler belirttiğiniz API sağlayıcıya gönderilir.

Aşağıdaki tabloda, API Sağlayıcısını Bildir bölümünde etkinlik türlerine göre bildirimler listelenmiştir. Daha fazla bilgi için Kullanıcı arayüzünü kullanarak bildirimleri düzenleme konusuna bakın.

Bir bildirimi 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. Bir bildirimi, yanındaki onay kutusunu seçerek etkinleştirebilir veya devre dışı bırakabilirsiniz.
3. Tüm değişiklikleri kaydetmek için Kaydet'i tıklayın.

Kaydetme işlemi birkaç dakika sürebilir. Bildirimlerin gerçekleştirildiğini onaylamak için kaydedildi.

API ile şablonları kullanarak bildirimleri ayarlama

Bildirimleri, aşağıdaki bölümlerde açıklandığı şekilde, API'yi kullanarak ayarlayın.

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

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

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

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

Bir GET yazarak para kazanma özelliğinin sağladığı tüm bildirim şablonlarını listeleyebilirsiniz /mint/organizations/{org_name}/notification-email-templates için istek. Ö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ştiricilere oda durumu hakkında bilgi veren bir etkinlik şablonu gösterilmektedir hakkında daha fazla bilgi edinin:

{
    "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 şablonu görüntüleme

Şu kullanıcıya GET isteği göndererek bildirim şablonunu görüntüleyin: /mint/organizations/{org_name}/notification-email-templates/{template_id}, 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

Şablonlarda $ ile başlayan öğeler değişkendir. Daha fazla bilgi için Bildirim şablonlarında değişkenleri kullanma konusuna bakın. Yukarıdaki değişkenlerin bildirimi şu değerlere göre değerlendirilir:

• ${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

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

Bildirim şablonuna iletinizi özelleştirirken bir veya daha fazla ileti ekleyebilirsiniz. değişkenlerine karşılık gelir. Daha fazla bilgi için Bildirimde değişken kullanma konusuna bakın şablonları ekleyin.

Ö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

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

Bildirim koşullarını ve işlemlerini yönetmek için: API'ye gidin.

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

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

/mint/organizations/{org_name}/notification-conditions adresine POST isteği.

İstekte bulunurken istek içeriğinde ve koşula ulaşıldığında gerçekleştirilecek işlemleri (ör. bildirim e-postası).

Bildirim koşullarının ayrıntılarını, bir veya daha fazla özellik belirterek tanımlarsınız. değerler. Liste için Bildirim koşulları için yapılandırma özellikleri konusuna bakın. özellikler. Bir etkinlik bildiriminde, yeni bir ürün aşağıdaki durumlarda yayınlanmış.

actions öğesini tanımlarken geçerli bildirim şablonuna başvurun. Görüntüleyin İşlemler listesi için Bildirim işlemleri için yapılandırma özellikleri.

Örneğin, aşağıdaki istek, özellik NEW_PRODUCT ve PUBLISHED özelliğinin değeri: true, şablondaki şu kimliğe sahip bildirimi gönderin: 01191bf9-5fdd-45bf-8130-3f024694e63 (bu DEFAULT_NEW_PRODUCT_TEMPLATE) tıklayın.

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

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

Bildirim koşulunu ve şuna GET isteği göndererek işlemi görüntüleyin: organizations/{org_name}/notification-conditions/{condition_Id}, burada: {condition_Id} koşulun kimliğidir. Kimlik, bildirim koşulu. Ö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ıtın bir örneği 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"
    } ]
    }

Bildirim koşulunu ve işlemi API'yi kullanarak düzenleme

Bildirim koşulunu ve işlemi şu adrese POST isteği göndererek düzenleyin: organizations/{org_name}/notification-conditions/{condition_Id}, burada: {condition_Id} koşulun kimliğidir. Kimlik, bildirim koşulu. İsteği gönderirken istek içeriğinde bunu kontrol edebilirsiniz.

Ö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

Bir bildirim koşulunu ve işlemi API'yi kullanarak silme

Bir bildirim koşulunu silmek için şuna DELETE isteği gönderin: organizations/{org_name}notification-conditions/{condition_Id} Ö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

Bildirim koşulları için aşağıdaki yapılandırma özellikleri, API kullanılırken 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

İletiyi bir bildirim şablonuna düzenlediğinizde bir veya daha fazla değişken ekleyebilirsiniz. Transaction'da döndürülen değerleri temsil etmek için Spring Expression Language (SpEL) kullanarak nesnesini tanımlayın.

Aşağıdaki tabloda en sık kullanılan bildirim şablonu değişkenleri özetlenmektedir.