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

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

Giriş

Ayarlanabilir bir bildirim planında API sağlayıcısı, 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 belirli bir yüzdesine (ör. %90, %100 veya %150) göre yapılandırabilirsiniz. Hedef sayıya ulaşıldığında ek işlemler engellenmez.

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

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

Edge

Edge kullanıcı arayüzünü kullanarak ayarlanabilir bir bildirim planı yapılandırmak için, bir ücret planı eklerken veya düzenlerken Adjustable Notification ücret planı türünü seçin ve Adjustable Notification 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ığı süre. Ay sayısını seçin (1-24 ay). 1 ay

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

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

  • Geliştiricilerden, API çağrısı mesajında sağlanan bir değere göre farklı bir ücret alır.
    Örneğin, uygulama geliştiricilerden API isteğinde iletilen bayt sayısına göre ücret almak isteyebilirsiniz.
  • Birden fazla API çağrısını tek bir işlemde gruplandırma.
    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)

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 bulunan Ücret Planı Türü alanında Düzenlenebilir Bildirim'i seçin.

    Ücret Planı penceresine erişim hakkında bilgi edinmek için Kullanıcı arayüzünü kullanarak ücret planı oluşturma bölümüne bakın.

  2. Yenileme Süresi alanını, planın otomatik olarak yenilendiği ay sayısına ayarlayın (geliştirici, sözleşmeyi bu tarihten önce feshetmediği sürece). Bu değeri 0 olarak ayarlarsanız plan, geliştirici tarafından sonlandırmayı seçene kadar etkin kalır.
  3. Genel Ücret Planı'nın altında Ayrıntılar'ı tıklayın.
  4. Toplama Temeli'ni, 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 kesinlikle emin olduğunuzda yayınlayın. Yayınlama Tarihi'ni ayarlama ve planın yayınlanması hakkında bilgi için Yayınlama ücreti planları bölümüne bakın.

    Bir ücret planı yayınladıktan sonra yalnızca bitiş tarihini değiştirebilirsiniz. Yayınlandıktan sonra bir ücret planını silemezsiniz ancak Yayınlanan bir ücret planının süresini sona erdirme bölümünde açıklandığı gibi, ücret planını sona erebilir ve gelecekteki bir ücret planıyla değiştirebilirsiniz.

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

/organizations/{org_name}/monetization-packages/{package_id}/rate-plans için bir POST isteğindeki istek gövdesindeki ratePlanDetails özelliğinde düzenlenebilir bildirim planı ayrıntılarını belirtin.

Ayarlanabilir bir bildirim planı belirtmek için istek gövdesinin RatePlanDetails öğesinde aşağıdaki değerleri belirtin:

Özellik Değer
type USAGE_TARGET olarak ayarlayın.
meteringType DEV_SPECIFIC olarak ayarlayın.
duration durationType ile birlikte, toplama temeli için zaman aralığına ayarlayın. Ayarlanabilir bildirim oranı planları için bunu 1 ile 24 arasında bir tam sayı olarak ayarlayın.
durationType

durationType ile birlikte, toplama temeli için zaman aralığına ayarlayın. Ayarlanabilir bildirim oranı planları için bu değeri MONTH olarak ayarlayın.

Düzenlenebilir bildirim planı ayrıntılarını belirtirken ayarlanabilen yapılandırma özellikleri hakkında daha fazla bilgi edinmek için Ücret planı ayrıntıları yapılandırma ayarları bölümüne bakın.

Örneğin aşağıda, toplama temeli 1 ay olarak ayarlanmış düzenlenebilir 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 kullanan her uygulama geliştirici için hedef işlem sayısını ayarlama

Ayarlanabilir bildirim oranı planını kabul eden her uygulama geliştirici için hedef işlem sayısını belirlemeniz gerekir. Bildirimlerin gönderilip gönderilmeyeceğini ve ne zaman gönderileceğini, hedef sayının belirli bir yüzdesine (ör. %90, %100 veya %150) göre 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ı ayarlayabilir ve değeri daha sonra güncelleyebilirsiniz.

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

Ücret planını kabul ederken hedef işlem sayısını ayarlamak için /organizations/{org_name}/developers/{developer_id}/developer-rateplans kaynağına yönelik bir POST isteğindeki istek gövdesinde quotaTarget özelliğini belirtin. Uygulama geliştirici için bildirimleri devre dışı bırakmak üzere quotaTarget değerini pozitif bir tam sayıya veya 0'a ayarlayın. Belirtilmezse quotaTarget varsayılan olarak 0 değerine ayarlanır.

Örneğin, aşağıdaki istek, uygulama geliştirici düzenlenebilir 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 bir PUT isteğindeki istek gövdesinde quotaTarget özelliğini /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} kaynağına belirtebilirsiniz. Uygulama geliştiricisi için bildirimleri devre dışı bırakmak için quotaTarget değerini pozitif bir tam sayıya veya 0'a ayarlayın. Belirtilmezse quotaTarget varsayılan olarak 0 değerine ayarlanır.

{developer_rateplan_id}, yayınlanan ücret planını kabul ettiğinizde yanıta 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} edinebilirsiniz. Buradaki {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 bölümüne bakın.

Ö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.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
 "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
 "developer":{
 "id":"dev@sirket1044%27%C5%B1%C3%B1m%C3%B1%C3%B1%C3%B1c%C5%C3%B1c%C5%c1%C3%BC4email:password