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ı her uygulama geliştiricinin hedef işlem sayısını ayarlayabilir. Hedef sayının belirli bir yüzdesine (ör. %90, %100 veya %150) ulaşıldığında bildirim gönderilip gönderilmeyeceğini ve gönderilecekse ne zaman gönderileceğini yapılandırabilirsiniz. Hedef sayıya ulaşıldıktan sonra ek işlemler engellenmez.

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

Aşağıda açıklandığı şekilde ayarlanabilir bildirim planlarını yapılandırın.

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

/organizations/{org_name}/monetization-packages/{package_id}/rate-plans adresine gönderilen bir POST isteğinin istek gövdesindeki ratePlanDetails özelliğinde 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:

Ayarlanabilir bildirim planı ayrıntıları belirtilirken ayarlanabilecek 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ğıda 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 kullanan her uygulama geliştirici için hedef işlem sayısını ayarlama

Uygulama geliştirici, ödeme planını kabul ettiğinde 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

Ü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ğinde istek gövdesindeki quotaTarget özelliğini belirtin. quotaTarget değerini pozitif bir tam sayı veya 0 olarak ayarlayarak uygulama geliştiricisi için bildirimleri devre dışı bırakın. Belirtilmezse quotaTarget varsayılan olarak 0 olur.

Örneğin, aşağıdaki istek, uygulama geliştiricisi 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 fiyat planı güncellenirken hedef işlem sayısını ayarlama

Hedef işlem sayısını ayarlamak için kabul edilen fiyat 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 özelliğini belirtebilirsiniz. Uygulama geliştiricisi için bildirimleri devre dışı bırakmak üzere quotaTarget değerini pozitif bir tam sayı veya 0 olarak ayarlayın. Belirtilmezse quotaTarget varsayılan olarak 0 olur.

Yayınlanan fiyat 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, geliştirici ücreti planı için /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans adresine GET isteği göndererek {developer-rateplan-id} değerini alabilirsiniz. Burada {developer_id}, geliştiricinin e-posta adresidir. Daha fazla bilgi için Bir geliştirici tarafından kabul edilen tüm fiyat 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.

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