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 aşağıdaki amaçlarla özelleştirebilirsiniz:
- Yeni ürünler, hüküm ve koşulların yeni sürümleri veya yeni ücret planları gibi etkinlikler hakkında tüm geliştiricileri bilgilendirin.
- Bu durumdan etkilenen geliştiricileri, revize edilmiş ücret planı gibi olaylar hakkında bilgilendirin.
- Bir geliştiricinin hesaba kaydolması veya bir geliştiricinin ücret planına kaydolması gibi geliştiriciyle ilgili etkinlikler hakkında bir API sağlayıcısını bilgilendirin.
- Tüm şirket yöneticilerini belirli bir etkinlik hakkında bilgilendirin.
Alternatif olarak, HTTP geri çağırma işleyici tanımlayan bir webhook oluşturabilir ve ardından Webhook kullanarak bildirimleri 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.
- Sol gezinme çubuğunda Yayınla > Para Kazanma > Bildirimler'i seçin.
Bildirimler sayfası görüntülenir.
Şekilde vurgulandığı gibi, Bildirimler sayfasında şunları yapabilirsiniz:
- Bildirim ayrıntılarını genişlet ve daralt
- 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
üzerinde oturum açın. Burada 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ı ile şunları yapabilirsiniz:
Bildirimleri düzenleme
Kullanıcı arayüzünü kullanarak bir bildirimi düzenlemek için:
- Bildirimler sayfasına erişin.
- Ayrıntılarını genişletmek için, düzenlemek istediğiniz bildirimin yanındaki işaretini tıklayın.
- Konu, Gövde ve Alıcı (varsa) alanlarını gerektiği gibi düzenleyin.
Bildirim şablonunda belirtilebilecek değişkenler hakkında bilgi için Bildirim şablonlarında değişkenleri kullanma bölümüne bakın.
Her kategoride bildirimleri düzenlemeyle ilgili daha fazla bilgi için aşağıdaki bölümlere bakın:
- Yanındaki onay kutusunu seçerek bir bildirimi etkinleştirin.
- Ek bildirimleri düzenlemek için 2-4. adımları tekrarlayın.
- Tüm değişiklikleri kaydetmek için Kaydet'i tıklayın.
Bildirimlerin kaydedildiğini onaylamak için bir mesaj görüntülenir. Kaydetme işlemi birkaç dakika sürebilir.
Tüm Geliştiricileri Bilgilendirmek için bildirimleri düzenleme
Tüm Geliştiricileri Bildir bölümünde seçtiğiniz etkinlik türlerine ilişkin bildirimler tüm geliştiricilere gönderilir.
Bildirimler gün sonunda çalışacak şekilde planlanır. Bildirimler gönderildikten sonra etkinlik onay kutuları otomatik olarak silinir. İlişkili etkinlik türleriyle ilgili bildirimleri planlamak için bunları tekrar seçmeniz gerekir.
Aşağıdaki tabloda, Tüm Geliştiricileri Bildir 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.
Etkinlik Türü | Tetikleyici | Notlar |
---|---|---|
Yeni paket | Yeni API paketi mevcut |
Güncellemenizin bir parçası olarak her yeni paketin adını (ve her pakette bulunan ürünleri) e-posta şablonunun gövdesine ekleyin. Ayrıca, geliştirici portalına veya bildirim hakkında daha fazla bilgi sağlayan başka herhangi bir web sitesine bağlantı 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. Ayrıca, geliştirici portalına veya bildirim hakkında daha fazla bilgi sağlayan başka herhangi bir web sitesine yönlendiren bir bağlantı da ekleyebilirsiniz. |
Yeni Pazarlar/Kapsam | Yeni API ürünleri belirli coğrafi pazarlarda kullanılabilir |
Güncellemenizin bir parçası olarak her yeni pazarın adını ve ilgili ürünleri e-posta şablonunun gövdesine ekleyin. Ayrıca, geliştirici portalına veya bildirim hakkında daha fazla bilgi sağlayan başka herhangi bir web sitesine bağlantı da ekleyebilirsiniz. |
Etkilenen Geliştiricileri Bilgilendirmek için bildirimleri düzenleme
Etkilenen Geliştiricileri Bildir bölümünde seçtiğiniz etkinlik türlerine ilişkin bildirimler, yalnızca bu tür etkinliklerden etkilenen geliştiricilere gönderilir. Örneğin, Düzeltilmiş ücret planı etkinliğini seçerseniz yalnızca ücret planını kabul eden geliştiricilere bildirim gönderilir.
Aşağıdaki tabloda, Etkilenen Geliştiricileri Bildir 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.
Etkinlik Türü | Tetikleyici | Notlar |
---|---|---|
Şartlar ve Koşullar kabul edilmedi veya süresi doldu | Yeni şartlar ve koşullar yayınlandı ve geliştirici bunları henüz kabul etmedi |
Bildirim, yeni şartlar 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ı:
|
Revize edilmiş ücret planı | Satın alınan ücret planının yeni bir sürümü mevcut |
Yalnızca mevcut sürümü satın alan geliştiricilere bildirim gönderilir. Bu bildirim, geliştiricilerin yeni sürümü incelemelerine ve yeni ücretleri kabul etmek istemedikleri takdirde planları sonlandırmalarına veya değiştirmelerine olanak tanır. |
Süresi dolmuş Ücret planı | Takip ücret planı olmadığından ücret planının süresi doldu |
Bu bildirim, ücret planını ilk kez geçerlilik süresi sona erecek şekilde ayarladığınızda gönderilir. Ek bildirimler, geçerlilik bitiş tarihinden 30, 7 ve 1 gün önce gönderilir. Yalnızca süresi dolmak üzere ücret planını satın alan geliştiricilere bildirim gönderilir. |
Yenilenen Ücret Planı | Ücret planı aboneliği yenilendi. |
Geçerli ücretlerin alınacağını geliştiriciye bildirin. |
Hız Sınırı Aşıldı | Ücret planı sınırı aşıldı |
Geçerli ücretlerin alınacağını geliştiriciye bildirin. |
Freemium Ücret Planı Tükenmiş | İşlem sayısı veya gün sayısına göre ölçülen ücretsiz kullanım dönemleri tükendiyse |
Ücretsiz kullanım süresi, satın alma opsiyonlu ücretsiz ücret planınıza göre belirlenir. |
Faturalandırma Belgesi yayınlandı |
Geliştiricinin faturalandırma belgeleri (faturalar gibi) mevcuttur. |
|
Geliştirici yeni Ücret Planı'na kaydoluyor | Geliştirici yeni bir ücret planına kaydolur. |
API Sağlayıcılarına Bildirilecek bildirimleri düzenleme
Bildir API Sağlayıcı bölümünde seçtiğiniz etkinlik türlerine ilişkin bildirimler, belirttiğiniz API sağlayıcısına gönderilir.
Aşağıdaki tabloda, Bildir API Sağlayıcısı 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.
Etkinlik Türü | Tetikleyici |
---|---|
Yeni Geliştirici Kayıtları |
Geliştirici bir hesaba kaydoldu. |
Geliştirici Bir Uygulama Ekle |
Geliştirici yeni bir uygulama oluşturdu. |
Yeni Ücret Planına Geliştirici Kaydı |
Geliştirici bir ücret planına kaydoldu. |
Geliştiricinin finansal bilgilerinde değişiklik yapması |
Geliştiricinin şirket adı veya şirket adresi gibi finansal bilgileri değiştirmiş olması. |
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:
- Bildirimler sayfasına erişin.
- Bir bildirimi, yanındaki onay kutusunu seçerek veya işaretini kaldırarak 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 onaylamak için bir mesaj görüntülenir.
API'yi kullanarak şablonları kullanarak bildirim oluşturma
API'yi kullanarak bildirimleri aşağıdaki bölümlerde açıklandığı şekilde ayarlayın.
API'yi kullanarak bildirim şablonlarını yönetme
Bildirim şablonlarını API'yi 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
/mint/organizations/{org_name}/notification-email-templates
için GET isteği göndererek para kazanma özelliğinin sağladığı tüm bildirim şablonlarını 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 yeni bir API ürününün kullanılabilirliği konusunda geliştiricileri 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 şablonu görüntüleme
/mint/organizations/{org_name}/notification-email-templates/{template_id}
için 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
Şablonlarda $ ile başlayan öğeler değişkenlerdir. Daha fazla bilgi için Bildirim şablonlarında değişkenleri kullanma bölümüne bakın. Bildirimdeki değişkenlerin aşağıdaki değerleri değerlendirdiğini varsayın:
${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ı şöyle 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}
için PUT isteği göndererek bildirim şablonunu düzenleyin.
Şablonun değiştirilen içeriğini istek gövdesine ekleyin.
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 bölümüne bakın.
Ö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 API kullanarak aşağıdaki bölümlerde açıklandığı şekilde 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şulunu ve işlemini 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
için bir POST isteği göndererek otomatik bildirimle sonuçlanan bir bildirim koşulu ve işlemi oluşturun.
İstekte bulunduğunuzda, istek gövdesinde bildirimle sonuçlanan koşulu ve koşula ulaşıldığında gerçekleştirilecek işlemleri (ör. bildirim e-postası gönderme) belirtin.
Bildirim koşulunun ayrıntılarını, bir veya daha fazla özellik değeri belirterek tanımlarsınız. Özellikler listesini Bildirim koşulları için yapılandırma özellikleri bölümünde bulabilirsiniz. Bir etkinlik bildirimi için yeni bir ürün yayınlandığında durum tetiklenebilir.
actions
öğesini tanımlarken geçerli bildirim şablonuna referans verin. İşlemler listesini görmek üzere Bildirim işlemleri için yapılandırma özellikleri bölümüne bakın.
Örneğin, aşağıdaki istek, özellik NEW_PRODUCT
ve PUBLISHED
özelliğinin değeri true
olduğunda 01191bf9-5fdd-45bf-8130-3f024694e63
kimliğiyle (bu, DEFAULT_NEW_PRODUCT_TEMPLATE
) bildirimin şablonda gönderilmesini 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
API'yi kullanarak bildirim koşulunu ve işlemini görüntüleme
organizations/{org_name}/notification-conditions/{condition_Id}
için GET isteği göndererek bir bildirim koşulunu ve işlemini görüntüleyin. Burada {condition_Id}
, koşulun kimliğidir. Bildirim koşulu 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ıtla ilgili bir örnek yer almaktadır:
{ "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şulunu ve işlemini düzenleme
organizations/{org_name}/notification-conditions/{condition_Id}
için POST isteği göndererek bir bildirim koşulunu ve işlemini düzenleyin. Burada {condition_Id}
, koşulun kimliğidir. Bildirim koşulu oluşturduğunuzda kimlik döndürülür. İsteği gönderdiğinizde, istek gövdesinde, bildirim koşulu 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}
için DELETE isteği göndererek bir 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.
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'yi kullanırken gerçekleşen 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
Bildirim şablonundaki mesajı düzenlediğinizde, Spring İfade Dili (SpEL) kullanarak Transaction nesnesinde döndürülen değerleri temsil eden bir veya daha fazla değişken ekleyebilirsiniz.
Aşağıdaki tabloda en sık kullanılan bildirim şablonu değişkenleri özetlenmiştir.
Değişken | Açıklama |
---|---|
${application.name} |
Uygulamanın adı. |
${application.products.name} |
Bir uygulamada yer alan ürünün adı. |
${BALANCE} |
Belirli bir kota için bakiye. |
${developer.legalName} |
Geliştirici şirketinin adı. |
${developer.name} |
Geliştiricinin adı. |
${EXPIRY_DATE} |
Bir sınırın süresinin dolduğu veya sıfırlandığı tarih veya saat. |
${LONG_PERCENT} |
% sembolü olmadan, geçerli kullanımla ulaşılan bir sınırın yüzdesi. Örneğin, 50 |
${PERCENT} |
Mevcut kullanımla ulaşılan bir sınırın yüzdesi (% sembolüyle). Ö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 gösterilen ücret). |
${QUOTA_UNIT} |
Sınır için temel birim: para birimi (harcama sınırı için) veya aramalar (işlem sınırı için). |
${QUOTA_LIMIT} |
Limit tutarı. |
${ratePlan.displayName} |
Ücret planı için tanımlanan görünen ad. |
${ratePlan.endDate} |
Bir API sağlayıcının ücret planını sonlandırdığı tarihtir. |
${ratePlan.monetizationPackage.displayName} |
Bir API paketinin adı. |
${ratePlan.monetizationPackage.name} |
Para kazanma paketinin adı. |
${ratePlan.monetizationPackage.products.displayName} |
Bir API ürünü için tanımlanan görünen ad. |
${ratePlan.monetizationPackage.products.name} |
Para kazanma paketinde yer alan bir ürünün adı. |
${ratePlan.startDate} |
Ücret planının oluşturulduğu tarihtir. |
${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 olarak noreply@Apigee.com adresi, şirketlere ve geliştiricilere gönderilen e-posta bildirimleri için kullanılacak şekilde 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.