Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Bildirim şablonları nedir?
Para kazanma, çeşitli etkinlik bildirimi türleri için örnek metni tanımlayan bir dizi şablon sağlar. Bu şablonlardan herhangi birini özelleştirerek şunları yapabilirsiniz:
- Yeni ürünler, Hükümler ve Koşullar'ın yeni sürümleri veya yeni ücret planları gibi etkinlikler hakkında tüm geliştiricileri bilgilendirin.
- Etkilenen geliştiricileri, revize edilmiş ücret planı gibi etkinlikler hakkında bilgilendirin.
- Geliştiricinin bir hesaba kaydolması veya ücret planına kaydolması gibi geliştiriciyle ilgili etkinlikler hakkında API sağlayıcıları bilgilendirin.
- Belirli bir etkinlikle ilgili olarak tüm şirket yöneticilerini bilgilendirebilirsiniz.
Alternatif olarak HTTP geri çağırma işleyicisini tanımlayan bir webhook oluşturabilir ve webhook kullanarak bildirim ayarlama bölümünde açıklandığı gibi webhook'u tetikleyen koşulu yapılandırabilirsiniz.
Bildirimler sayfasını keşfetme
Aşağıda açıklandığı şekilde Bildirimler sayfasına erişin.
Edge
Edge kullanıcı arayüzünü kullanarak Bildirimler sayfasına erişmek için:
- Apigee.com/edge adresinde oturum açın.
- Soldaki gezinme çubuğunda Yayınlama > Para kazanma > Bildirimler'i seçin.
Bildirimler sayfası görüntülenir.
Şekilde de belirtildiği gibi, Bildirimler sayfasında şunları yapabilirsiniz:
- Bildirim ayrıntılarını genişletme ve daraltma
- Bildirim ayrıntılarını düzenleme ve tüm düzenlemeleri kaydetme
- Bir bildirimi etkinleştirme veya devre dışı bırakma
Klasik Edge (Private Cloud)
Klasik Edge kullanıcı arayüzünü kullanarak Bildirimler sayfasına erişmek için:
http://ms-ip:9000
adresinde oturum açın. ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.Üst gezinme çubuğunda Yönetici > Bildirimler'i seçin.
Bildirimler sayfasında şunları yapabilirsiniz:
Bildirimleri düzenleme
Kullanıcı arayüzünü kullanarak bir bildirimi düzenlemek için:
- Bildirimler sayfasına gidin.
- Ayrıntılarını genişletmek için düzenlemek istediğiniz bildirimin yanındaki simgesini tıklayın.
- Konu, İçerik ve Alıcı (varsa) alanlarını gerektiği gibi düzenleyin.
Bir bildirim şablonunda belirtilebilecek 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:
- Bir bildirimin yanındaki onay kutusunu işaretleyerek bildirimi etkinleştirin.
- Diğer bildirimleri düzenlemek için 2-4 arasındaki adımları tekrarlayın.
- 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.
Bildirimleri Tüm Geliştiricileri Bildir olarak düzenleme
Tüm Geliştiricileri Bildir bölümünde seçtiğiniz etkinlik türleriyle ilgili bildirimler tüm geliştiricilere gönderilir.
Bildirimlerin günün sonunda yayınlanması planlanır. Bildirimler gönderildikten sonra etkinlik onay kutuları otomatik olarak temizlenir. İlişkili etkinlik türleri için bildirim planlamak üzere bunları tekrar seçmeniz gerekir.
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 Gösterim arayüzünü kullanarak bildirimleri düzenleme başlıklı makaleyi inceleyin.
Etkinlik Türü | Tetikleyici | Notlar |
---|---|---|
Yeni paket | Yeni API paketi kullanıma sunuldu |
Güncellemeniz kapsamında her yeni paketin adını (ve her pakette bulunan ürünleri) e-posta şablonunun gövdesine ekleyin. Geliştirici portalının veya bildirim hakkında daha fazla bilgi veren başka bir web sitesinin bağlantısını da ekleyebilirsiniz. |
Yeni ürün | Yeni API ürünü kullanıma sunuldu |
Güncellemenizin bir parçası olarak her yeni ürünün adını e-posta şablonunun gövdesine ekleyin. Geliştirici portalının veya bildirim hakkında daha fazla bilgi sağlayan başka bir web sitesinin bağlantısını da ekleyebilirsiniz. |
Yeni Pazarlar/Kapsam | Yeni API ürünleri belirli coğrafi pazarlarda kullanılabilir |
Güncellemeniz kapsamında, her yeni pazarın adını ve ilgili ürünlerin adını e-posta şablonunun gövdesine ekleyin. Geliştirici portalının veya bildirim hakkında daha fazla bilgi veren başka bir web sitesinin bağlantısını da ekleyebilirsiniz. |
Etkilenen Geliştiricilere Bilgilendirmek için bildirimleri düzenleme
Etkilenen Geliştiricileri Bildir bölümünde seçtiğiniz etkinlik türleriyle ilgili bildirimler yalnızca bu tür etkinliklerden etkilenen geliştiricilere gönderilir. Örneğin, Düzeltilmiş ücret planı etkinliğini seçerseniz bildirim yalnızca ücret planını kabul eden geliştiricilere gönderilir.
Aşağıdaki tabloda, Etkilenen Geliştiricileri Bildir bölümünde etkinlik türlerine göre bildirimler listelenmiştir. Daha fazla bilgi için Gösterim arayüzünü kullanarak bildirimleri düzenleme başlıklı makaleyi inceleyin.
Etkinlik Türü | Tetikleyici | Notlar |
---|---|---|
Şartlar ve koşullar kabul edilmedi veya süresi doldu | Yeni bir Hükümler ve Koşullar grubu yayınlandı ve geliştirici henüz bunları kabul etmedi |
Bildirim, yeni Hüküm ve Koşullar'ın yürürlüğe girmesinden 30 gün, 7 gün ve 1 gün önce gönderilir. |
Yeni ücret planı | Yeni ücret planları yayınlandı |
Ücret planı:
|
Düzeltilmiş ücret planı | Satın alınan ücret planının daha yeni bir sürümü mevcut |
Yalnızca geçerli sürümü satın alan geliştiricilere bildirim gönderilir. Bu bildirim, geliştiricilerin yeni sürümü gözden geçirmelerine ve yeni ücretleri kabul etmek istemedikleri takdirde planları iptal etmelerine veya değiştirmelerine olanak tanır. |
Süresi dolan ücret planı | Ücret planının süresi doldu ve takip eden bir ücret planı yok |
Bu bildirim, ücret planını süresi dolacak şekilde ilk olarak ayarladığınızda, geçerlilik bitiş tarihinden 30, 7 ve 1 gün önce ek bildirimler gönderilir. Yalnızca süresi dolacak ücret planını satın almış olan geliştiricilere bildirim gönderilir. |
Yenilenen Ücret Planı | Ücret planı aboneliği yenilendi. |
Geliştiriciye geçerli ücretlerin alınacağını bildirin. |
Sıklık sınırı aşıldı | Ücret planı sınırı aşıldı |
Geçerli ücretlerin alınacağını geliştiriciye bildirin. |
Ücretsiz Premium Ücret Planı Tükendi | İşlem sayısına veya güne göre ölçülen ücretsiz kullanım dönemleri sona erdi |
Ücretsiz kullanım süresi, freemium ücret planınızla tanımlanır. |
Faturalandırma belgesi yayınlandı |
Geliştiricinin faturalandırma belgeleri (ör. faturalar) mevcut. |
|
Geliştirici yeni ücret planına kaydoluyor | Geliştirici yeni bir ücret planına kaydoluyor. |
API Sağlayıcılarını Bilgilendirmek için bildirimleri düzenleme
API sağlayıcıyı bilgilendir bölümünde seçtiğiniz etkinlik türleriyle ilgili bildirimler, belirttiğiniz API sağlayıcısına gönderilir.
Aşağıdaki tabloda, Notify API Sağlayıcısı bölümündeki etkinlik türlerine göre bildirimler listelenmektedir. Daha fazla bilgi için Gösterim arayüzünü kullanarak bildirimleri düzenleme başlıklı makaleyi inceleyin.
Etkinlik Türü | Tetikleyici |
---|---|
Yeni Geliştirici Kaydolur |
Geliştirici bir hesaba kaydolmalıdır. |
Geliştirici Uygulama Ekler |
Geliştirici, yeni bir uygulama oluşturdu. |
Yeni Ücret Planı İçin Geliştirici Kaydı |
Geliştirici bir ücret planına kaydolmuştur. |
Geliştiricinin finansal ayrıntıları değiştirmesi |
Geliştirici, şirket adı veya şirket adresi gibi finansal ayrıntıları değiştirdi. |
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:
- Bildirimler sayfasına erişin.
- Bir bildirimin yanındaki onay kutusunu işaretleyerek veya işaretini kaldırarak bildirimi etkinleştirin ya da devre dışı bırakın.
- 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 ile şablonları kullanarak bildirimleri ayarlama
API'yi kullanarak aşağıdaki bölümlerde açıklandığı şekilde bildirimleri ayarlayın.
API'yi kullanarak bildirim şablonlarını yönetme
API'yi kullanarak aşağıdaki bölümlerde açıklandığı gibi bildirim şablonlarını yönetin:
- API'yi kullanarak tüm bildirim şablonlarını görüntüleme
- API'yi kullanarak bildirim şablonunu görüntüleme
- API'yi 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ı listelemek için /mint/organizations/{org_name}/notification-email-templates
adresine GET isteği gönderebilirsiniz. Ö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ğıdaki etkinlik şablonu geliştiricileri yeni bir API ürününün kullanıma sunulduğu konusunda bilgilendirir:
{ "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}
öğesine bir GET isteği göndererek bir 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 sahip 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.
Şablonun değiştirilen içeriğini istek gövdesinde sağlayın.
Bir 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
API'yi kullanarak aşağıdaki bölümlerde açıklandığı gibi bildirim koşullarını ve işlemlerini yönetin.
- API'yi kullanarak bildirim koşulu ve işlemi oluşturma
- API'yi kullanarak bildirim koşulunu ve işlemi görüntüleme
- API'yi kullanarak bildirim koşulunu ve işlemi düzenleme
- API'yi kullanarak bildirim koşulunu ve işlemi silme
API'yi kullanarak bildirim koşulu ve işlem 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.
İstekte bulunurken, istek gövdesinde bildirimin hangi koşulun geçerli olduğunu ve koşula ulaşıldığında gerçekleştirilecek 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 bölümüne bakın. Etkinlik bildirimi için bu koşul, yeni bir ürün yayınlandığında tetiklenebilir.
actions
değerini tanımlarken geçerli bildirim şablonuna bakın. İşlemlerin listesini Bildirim işlemleri için yapılandırma özellikleri başlıklı makalede bulabilirsiniz.
Örneğin, aşağıdaki istek, özellik NEW_PRODUCT
ve PUBLISHED
özelliğinin değeri true
olduğunda, şablondaki bildirimi 01191bf9-5fdd-45bf-8130-3f024694e63
(bu, DEFAULT_NEW_PRODUCT_TEMPLATE
) kimliğiyle göndereceğini belirtir.
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
organizations/{org_name}/notification-conditions/{condition_Id}
öğesine bir GET isteği göndererek bir bildirim koşulunu ve işlemi görüntüleyin. Burada {condition_Id}
, koşulun kimliğidir. Bildirim koşulunu oluşturduğunuzda kimlik 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ı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
organizations/{org_name}/notification-conditions/{condition_Id}
adresine POST isteği göndererek bir bildirim koşulunu ve işlemini düzenleyin. Bu durumda, {condition_Id}
koşulun kimliğidir. Bildirim koşulunu oluşturduğunuzda kimlik döndürülür. İsteği gönderirken bildirim koşulunda veya işlemde yapmak istediğiniz değişiklikleri istek gövdesinde 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şlemi silme
organizations/{org_name}notification-conditions/{condition_Id}
adresine 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
Bildirim koşulları için aşağıdaki yapılandırma özellikleri, API kullanılırken kullanılabilir.
Ad | Açıklama | Varsayılan | Zorunlu mu? |
---|---|---|---|
attribute |
Bildirim koşulunun ayrıntıları. Bildirim koşulunu hassaslaştırmak için bir veya daha fazla özellik belirtebilirsiniz. Değer aşağıdakilerden biri veya daha fazlası olabilir:
|
Yok | Evet |
value |
Özelliğin değeri. |
Yok | Hayır |
associatedCondition |
İlişkili bir koşula referans. |
Yok | Hayır |
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.
Ad | Açıklama | Varsayılan | Zorunlu mu? |
---|---|---|---|
actionAttribute |
Bildirim alıcısını tanımlamak için kullanılan yöntem. Değer aşağıdakilerden biri veya daha fazlası olabilir:
|
Yok | Evet |
value |
İşlem özelliğinin değeri.
|
Yok | Evet |
templateID |
Bildirim şablonunun kimliği. Not: |
Yok | Evet |
postURL |
Webhook için geri çağırma işleyici. Not: |
Yok | Evet |
Bildirim şablonlarında değişkenleri kullanma
Bir bildirim şablonundaki mesajı düzenlerken, Transaction nesnesinde döndürülen değerleri temsil etmek için Spring Expression Language'i (SpEL) kullanarak bir veya daha fazla değişken ekleyebilirsiniz.
Aşağıdaki tabloda en sık kullanılan bildirim şablonu değişkenleri özetlenmektedir.
Değişken | Açıklama |
---|---|
${application.name} |
Uygulamanın adı. |
${application.products.name} |
Bir uygulamaya dahil edilen ürünün adı. |
${BALANCE} |
Belirli bir kotanın bakiyesi. |
${developer.legalName} |
Geliştiricinin şirketinin adı. |
${developer.name} |
Bir geliştiricinin adı. |
${EXPIRY_DATE} |
Sınırın süresinin dolacağı veya sıfırlandığı tarih veya saat. |
${LONG_PERCENT} |
% simgesi olmadan, mevcut kullanımla ulaşılan sınırın yüzdesi. Örneğin, 50 |
${PERCENT} |
Mevcut kullanımla ulaşılan sınırın yüzdesi ("%" sembolü ile). Örneğin, %50. |
${products.displayName} |
Bir ürün için tanımlanan görünen ad. |
${QUOTA_TYPE} |
Sınır türü (işlem hacmi, harcama sınırı veya ücret karşılaşması). |
${QUOTA_UNIT} |
Sınırın temel birimi: para birimi (harcama sınırı için) veya çağrı (işlem sınırı için). |
${QUOTA_LIMIT} |
Sınır tutarı. |
${ratePlan.displayName} |
Bir ücret planı için tanımlanan görünen ad. |
${ratePlan.endDate} |
Bir API sağlayıcının ücret planını sonlandırdığı tarih. |
${ratePlan.monetizationPackage.displayName} |
API paketinin adı. |
${ratePlan.monetizationPackage.name} |
Para kazanma paketinin adı. |
${ratePlan.monetizationPackage.products.displayName} |
API ürünü için tanımlanan görünen ad. |
${ratePlan.monetizationPackage.products.name} |
Para kazanma paketine dahil edilen bir ürünün adı. |
${ratePlan.startDate} |
Ücret planının oluşturulduğu tarih. |
${USAGE} |
Mevcut kullanım (toplam gelir veya ödemeler ya da hacim). |
${USER} |
Kullanıcının adı. |
Yanıt e-posta adresinizi özelleştirme
Para kazanma için varsayılan noreply@Apigee.com adresi, şirketlere ve geliştiricilere gönderilen e-posta bildirimlerinde kullanılmak üzere 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.