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

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

Giriş

Ayarlanabilir bir bildirim planında API sağlayıcı, her uygulama geliştirici için hedef işlem sayısını ayarlayabilir. Bildirimlerin gönderilip gönderilmeyeceğini ve ne zaman gönderileceğini, hedef sayının bir yüzdesine (ör. %90, %100 veya %150) ulaşıldığında yapılandırabilirsiniz. Hedef sayıya ulaşıldığında ek işlemler 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 ayarlanabilir bildirim planı yapılandırmak için ücret planı eklerken veya düzenlerken Ayarlanabilir Bildirim ücret planı türünü seçin ve Ayarlanabilir 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ığı. Bir ay sayısı (1-24 ay) seçin. 1 ay

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

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

  • Geliştiricilerden, API çağrısının mesajında sağlanan değere göre değişken bir tutar tahsil edin.
    Örneğin, uygulama geliştiricilerden API isteğinde iletilen bayt sayısına göre ücret alabilirsiniz.
  • Birden fazla API çağrısını tek bir işlemde gruplandırın.
    Bu durumda, Özel derecelendirme parametresini kullan'ı seçin ve açılır listeden özel özelliği seçin.

Daha fazla bilgi için Fiyat planını özel özelliklerle yapılandırma başlıklı makaleyi inceleyin.

Klasik Edge (Private Cloud)

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

  1. Ücret Planı penceresindeki Plan Ayrıntıları sekmesinde yer alan Ücret Planı Türü alanında Düzenlenebilir Bildirim'i seçin.

    Ücret planı penceresine erişme hakkında bilgi edinmek için Kullanıcı arayüzünü kullanarak ücret planı oluşturma başlıklı makaleye bakın.

  2. Yenileme Süresi alanını, planın otomatik olarak yenileneceği ay sayısına ayarlayın (geliştirici bu tarihten önce sözleşmeyi feshetmediği sürece). Bu değeri 0 olarak ayarlarsanız plan, geliştirici sonlandırmayı seçene kadar geçerli kalır.
  3. Genel Fiyat Planı altında Ayrıntılar'ı tıklayın.
  4. Toplama Tabanı'nı, işlem hacminin toplandığı döneme ayarlayın. 1 ile 24 ay arasında bir sayı seçin. Bu değer varsayılan olarak 1 aydır.
  5. Uygula ve Kapat'ı tıklayın.
  6. Taslağı Kaydet'i tıklayın.
  7. Planı yalnızca nihai olduğundan emin olduğunuzda yayınlayın. Yayınlanma tarihini ayarlama ve planı yayınlama hakkında bilgi edinmek için Yayın ücreti planları başlıklı makaleyi inceleyin.

    Ücret planını yayınladıktan sonra yalnızca bitiş tarihini değiştirebilirsiniz. Yayınlanan bir ücret planını silemezsiniz ancak Yayınlanan bir ücret planının süresini sonlandırma bölümünde açıklandığı gibi, ücret planının süresini sonlandırıp gelecekteki bir ücret planıyla değiştirebilirsiniz.

API'yi kullanarak ayarlanabilir bir bildirim planı oluşturma

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

Ayarlanabilir bir bildirim planı belirtmek için istek gövdesinin ratePlanDetails bölümünde aşağıdaki değerleri belirtin:

Mülk Değer
type USAGE_TARGET olarak ayarlayın.
meteringType DEV_SPECIFIC olarak ayarlayın.
duration durationType ile birlikte toplama tabanının zaman aralığına ayarlanır. Ayarlanabilir bildirim ücreti planları için bu değeri 1 ile 24 arasında bir tam sayı olarak ayarlayın.
durationType

durationType ile birlikte toplama tabanının zaman aralığına ayarlanır. Ayarlanabilir bildirim ücreti planları için bu değeri MONTH olarak ayarlayın.

Ayarlanabilir bildirim planı ayrıntılarını belirtirken ayarlanabilen yapılandırma özellikleri hakkında daha fazla bilgi için Fiyat planı ayrıntıları yapılandırma ayarları başlıklı makaleyi inceleyin.

Örneğin, aşağıdaki örnekte toplama temeli 1 ay olarak ayarlanmış, ayarlanabilir bir bildirim planı tanımlanmaktadır.

$ 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

API'yi kullanarak her uygulama geliştirici için hedef işlem sayısını ayarlama

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

Geliştirici ücret planını kabul ettiğinde uygulama geliştirici için hedef işlem sayısını belirleyebilir ve değeri daha sonra güncelleyebilirsiniz.

Ücret planını kabul ederken hedef işlem sayısını ayarlama

Fiyat planını kabul ederken hedef işlem sayısını ayarlamak için /organizations/{org_name}/developers/{developer_id}/developer-rateplans kaynağına gönderilen bir POST isteğinde istek gövdesinde quotaTarget mülkünü belirtin. Uygulama geliştirici bildirimlerini devre dışı bırakmak için quotaTarget öğesini pozitif bir tam sayı olarak veya 0 olarak ayarlayın. Belirtilmezse quotaTarget varsayılan olarak 0 değerine ayarlanır.

Örneğin, aşağıdaki istek, uygulama geliştirici ayarlanabilir bildirim planını kabul ettiğinde hedef işlem sayısını 4.000 olarak ayarlar.

$ 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üncelleyebilir ve /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} kaynağına yönelik bir PUT isteğinde istek gövdesinde quotaTarget mülkünü belirtebilirsiniz. Uygulama geliştirici bildirimlerini devre dışı bırakmak için quotaTarget öğesini pozitif bir tam sayı olarak veya 0 olarak ayarlayın. Belirtilmezse quotaTarget varsayılan olarak 0 değerine ayarlanır.

Yayınlanan ücret planını kabul ettiğinizde yanıtta {developer_rateplan_id} döndürülür.

Ö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 /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans adresine GET isteği göndererek geliştirici ücret planı için {developer-rateplan-id} alabilirsiniz. Burada {developer_id}, geliştiricinin e-posta adresidir. Daha fazla bilgi için Geliştirici tarafından kabul edilen tüm ücret planlarını görüntüleme başlıklı makaleyi inceleyin.

Ö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 istek, hedef işlem sayısını 4.000 olarak günceller.

email:password