Ayarlanabilir bildirim planını yapılandırın

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

Giriş

API sağlayıcı, düzenlenebilir bir bildirim planında işlem sayısını gösterir. Bildirimlerin şu özelliğe göre gönderilip gönderilmeyeceğini ve ne zaman gönderileceğini yapılandırabilirsiniz: hedef sayının bir yüzdesine (ör. %90, %100 veya %150) ulaşıldığında gösterilir. Ek bilgiler işlemler, hedef sayıya ulaşıldıktan sonra engellenmez.

Kullanıcı arayüzünü kullanarak düzenlenebilir bir bildirim planı yapılandırma

Aşağıda açıklandığı şekilde, düzenlenebilir bildirim planları yapılandırın.

Edge

Edge kullanıcı arayüzünü kullanarak düzenlenebilir bir bildirim planı yapılandırmak için ücret ekleme veya düzenleme sırasında planınız için Düzenlenebilir Bildirim ücret planı türünü seçin ve Düzenlenebilir Bildirim bölümünde aşağıdaki bilgileri yapılandırın:

Alan Açıklama Varsayılan
Hesaplama sıklığı İşlem hacminin (veya özel özellikle ilgili hacmin) hesaplandığı zaman aralığı. Ay sayısı (1-24 ay) seçin. 1 ay

API ürününüz için özel özellikler tanımladıysanız özel özelliğe dayalı bir işlem sayacı tanımlamak üzere özel bir puan parametresi yapılandırabilirsiniz.

Örneğin, şunları yapmanız gerekebilir:

  • Geliştiricilerden, API çağrısı mesajında belirtilen değere göre değişken bir tutar tahsil edin.
    . Örneğin, uygulama geliştiricilerini API isteğinde iletilen bayt sayısına göre ücretlendirebilirsiniz.
  • Birden çok API çağrısını tek bir işlemde birleştirin.
    . Bu durumda, Özel puan parametresi kullan'ı seçin ve açılır listeden özel özelliği seçin.

Daha fazla bilgi için Özel özelliklerle ücret planını yapılandırma bölümüne bakın.

Klasik Edge (Private Cloud)

Classic Edge kullanıcı arayüzünü kullanarak ayarlanabilir bildirim planlarını yapılandırmak için:

  1. Ücret Planı Türü bölümünde Düzenlenebilir Bildirim'i seçin. "Ücret Planı" penceresindeki Plan Ayrıntıları sekmesinde "seçeneğini tıklayın.

    Kullanıcı arayüzünü kullanarak ücret planı oluşturma başlıklı makaleyi inceleyin ziyaret edin.

  2. Yenileme Süresi alanını planın hangi ay için geçerli olduğunu belirtin otomatik olarak yenilenir (geliştirici, sözleşmeyi söz konusu tarihten önce feshetmediği sürece). Eğer bu değeri 0 olarak ayarlarsanız plan, geliştirici tarafından sonlandırılana kadar yürürlükte kalır.
  3. Genel Ücret Planı'nın altında Ayrıntılar'ı tıklayın.
  4. Toplama Temeli'ni, hacmin hacim toplanan verileri gösterir. 1 ile 24 ay arasında bir sayı seçin. Bu değer varsayılan olarak 1'e ayarlanır. ay.
  5. Uygula ve Kapat'ı tıklayın.
  6. Taslağı Kaydet'i tıklayın.
  7. Planı yalnızca nihai olduğundan kesinlikle emin olduğunuzda yayınlayın. Aşağıdakiler için Yayınlama ücreti planları bölümüne bakın: ve planın yayınlanmasıyla ilgili daha fazla bilgi edinmek için Yardım Merkezi'ni ziyaret edebilirsiniz.

    Ücret planını yayınladıktan sonra yalnızca bitiş tarihini değiştirebilirsiniz. Fiyatları silemezsiniz ancak ücret planını iptal edip gelecekteki bir ücretle değiştirebilirsiniz. Yayınlanmış bir ücretin son kullanma tarihinin sona ermesi" bölümünde hakkında daha fazla bilgi edinin.

API'yi kullanarak ayarlanabilir bildirim planı yapılandırma

ratePlanDetails mülkünde ayarlanabilir bildirim planı ayrıntılarını belirtin. bir POST isteğindeki istek gövdesinde /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Ayarlanabilir bir bildirim planı belirtmek için İstek gövdesinin RatePlanDetails:

Özellik Değer
type USAGE_TARGET olarak ayarlayın.
meteringType DEV_SPECIFIC olarak ayarlayın.
duration Toplama için zaman aralığını, durationType Ayarlanabilir bildirim ücreti planları için bunu tam sayı olarak ayarlayın. 1 ile 24 arasında olmalıdır.
durationType

Toplama için zaman aralığını, durationType Ayarlanabilir bildirim ücreti planları için bu değeri ayarlayın MONTH numaralı telefona.

Belirtirken ayarlanabilecek yapılandırma özellikleri hakkında daha fazla bilgi için ayarlanabilir bildirim planı ayrıntıları başlıklı makaleye göz atın: Ücret planı ayrıntıları yapılandırma ayarlarına gidin.

Örneğin, aşağıda toplama temelli düzenlenebilir bir bildirim planı tanımlanmaktadır 1 ay olarak ayarlandı.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

Hedefi belirleme her uygulama geliştiricinin API'yi kullanan işlem sayısı

Ayarlanabilir bildirim ücreti planını kabul eden her uygulama geliştirici için şunları yapmanız gerekir: Hedef işlem sayısını belirleyin. Bildirimlerin gönderilip gönderilmeyeceğini ve ne zaman gönderileceğini yapılandırabilirsiniz hedef sayının bir yüzdesine ulaşıldığı zamanı temel alır (ör. %90, %100 veya %150). Hedef sayıya ulaşıldıktan sonra ek işlemler engellenmez.

Geliştirici kabul ettiğinde uygulama geliştirici için hedef işlem sayısını ayarlayabilirsiniz ücreti planlayabilir, değeri daha sonra güncelleyebilirsiniz.

Ücret planı kabul edilirken hedef işlem sayısını belirleme

Ücret planını kabul ederken hedef işlem sayısını ayarlamak için quotaTarget özelliği, /organizations/{org_name}/developers/{developer_id}/developer-rateplans kaynak. Uygulama bildirimlerini devre dışı bırakmak için quotaTarget öğesini pozitif bir tam sayı veya 0 olarak ayarlayın. geliştiriciyim. Belirtilmezse quotaTarget varsayılan olarak 0 olur.

Örneğin, aşağıdaki istek, uygulama etkinken işlemlerin hedef sayısını 4.000 olarak Geliştiricinin ayarlanabilir bildirim planını kabul etmesi gerekir.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Kabul edilen ücret planını güncellerken hedef işlem sayısını belirleme

Hedef işlem sayısını ayarlamak için kabul edilen ücret planını güncelleyip belirtebilirsiniz. PUT isteğindeki istek gövdesindeki quotaTarget özelliğini /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} gösterir. Devre dışı bırakmak için quotaTarget değerini pozitif bir tam sayı veya 0 olarak ayarlayın bildirimler gönderilir. Belirtilmezse quotaTarget varsayılan olarak 0 olur.

Şu koşulları kabul ettiğinizde yanıtta {developer_rateplan_id} döndürülür: ücret planı görüntülenebilir.

Örneğin:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Alternatif olarak geliştirici ücreti için {developer-rateplan-id} edinebilirsiniz bir GET isteği göndererek /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, Burada {developer_id}, geliştiricinin e-posta adresidir. Daha fazla bilgi için Şu iş ortağı tarafından kabul edilen tüm ücret planlarını görüntüleme: deneyin.

Örneğin:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

Aşağıdaki istekte hedef işlem sayısı 4.000 olarak güncellenir.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@sirketim.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "15.04.2016 00:00:00",
   "quotaTarget": 4000,
   "suppressAlert":yanlış
}" \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password