Özel özelliklerle ücret planını yapılandırma

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

Giriş

Bazı durumlarda, işlem sayaçlarının bir değişkene veya özel değere dayalı olması gerekebilir. Örneğin, şunları yapmanız gerekebilir:

• Geliştiricilerden, API mesajında belirtilen değere göre değişken bir ödeme alın çağrısına bir tıklama URL'si eklemeniz gerekir. Örneğin, uygulama geliştiricilerini bayt sayısına göre iletilebilir.
• Birden çok API çağrısını tek bir işlemde birleştirin.

Özel özelliklerle ücret planlarını kullanarak bir API'nin mesajındaki değeri tanımlayabilirsiniz. çağrısı gibi, işlem sayıları ile masrafları hesaplamak için kullanılan bir sayaç görevi görür.

Özel özelliklere sahip aşağıdaki ücret planları desteklenir:

• Özel özelliğe sahip ücret listesi
• Özel özelliğe sahip ayarlanabilir bildirim

Ücret planı başına en fazla on özel özellik ayarlayabilirsiniz.

Özel özellik hesaplamalarını anlama

Özel özellik değerinin, ücret planı işlem sayılarında ve ödemelerinde nasıl hesaba katıldığı aşağıdaki tabloda özetlendiği üzere şarj modeline bağlıdır.

Ücret planı özel özellik değeri

API ürün paketinde yer alan İşlem Kaydı Politikası, para kazanma özelliğinin mesajı gösterilir. Özel özelliği, Özel Özellikler'de tanımlarsınız bölümünde bulabilirsiniz.

Ardından, API oluşturduktan sonra ücret planında bu özel özelliği seçebilirsiniz. şununla birlikte işlem kaydetme politikasını içeren ürün paketi: tanımlanmış özel bir özellik bulunuyor.

Üst düzey akış şu şekildedir:

1. Bir API ürünü eklerken özel özellikleri tanımlayın.
2. Ürünü içeren bir API ürün paketi oluşturun.
   API ürün paketinin işlem kayıt politikasında, ücret planlarını tanımlamak için kullanılır.
3. Ücret listesi veya düzenlenebilir bildirim türünde bir ücret planı oluşturun seçeneğini belirtin ve bir özel derecelendirme parametresi belirtin.

Aşağıdaki şekilde, işlem kaydetme politikası ve ücret listesi planı yapılandırması. İlgili içeriği oluşturmak için kullanılan özel özellik ücret planı ilişkisiyle ayarlanabilir bildirim benzerdir ancak hacim bantlı değer geçerli değildir.

Özel rapor nasıl oluşturulur? özellik değeri

İşlemi kaydetme politikası, özel özellik değerini birkaç yerde arayabilir. Örneğin yanıt başlığı, yanıt gövdesi veya yanıttaki önceden tanımlanmış akış değişkenleri. (Bir işlem başarılı bir şekilde elde edilene kadar resmi olmadığı için istek kullanılamaz response.) Aşağıda, mesajın sayısal değerini de ekler. Her iki durumda da İleti Ata Politikası'nı kullanacağız. birlikte kullanabilirsiniz.

İstek yük boyutu yanıt başlığına ekleniyor

Her mesaj isteğinde, bir client.received.content.length değişkeni bulunur ve istek yükündeki bayt sayısını içerir. Bir Proxy Uç Nokta Yanıtı olsun, messageSize adlı bir yanıt başlığı oluşturabiliriz. şu uzunluk değerini içerir:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Başlığa uygulama özel özelliği değeri ekleme

Hemen hemen aynı şekilde, bir uygulamadaki özel özelliğin değerini içeren bir başlık da oluşturabiliriz. Örneğin, her geliştiriciye apprating adlı özel bir özellik eklerseniz aşağıdaki gibi kullanabilirsiniz:

API Anahtarını Doğrula politikasını (para kazanma için gereklidir) kullanırken bu değer verifyapikey.{policy_name}.apprating adlı bir değişkende depolanır. Ödevler sekmesinde Proxy Uç Nokta yanıtına eklenmiş ileti politikası varsa Uygulamanın apprating değerini içeren apprating:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Ücret planını ayarlama

Yukarıda açıklanan özel özellik ayarlarının dışında, ücret planı da aynı şekilde ayarlanır. olduğu gibi (özel özellikler içermeyen ücret planları için) ancak lütfen unutmayın.

Kullanıcı arayüzünü kullanarak özel özellikle ücret listesi planını yapılandırma

Ücret listesi planlarını, aşağıdaki bölümlerde açıklandığı gibi Edge kullanıcı arayüzü veya Klasik Edge kullanıcı arayüzünü kullanarak özel özelliklerle yapılandırın.

Kullanıcı arayüzünü kullanarak özel özelliklerle ayarlanabilir bildirim planı yapılandırma

API kullanarak özel özellikler içeren ücret planının ayrıntılarını belirtme

Aşağıdaki ön koşul adımlarını uygulayın:

1. Bir API ürününün işlemi kaydetme politikasına, ücret planlarını tanımlamak için kullanılır. Ayrıntılar için İşlem oluşturma kaydetme politikasına tabidir. Bu işlemi, API paketine dahil etmek istediğiniz her API ürünü için yapın.
2. API ürünleri ve işlem kaydetme politikaları tam olarak sizin tarafınızdan ürünü içeren bir API paketi oluşturun. API paketleri oluşturma başlıklı makaleyi inceleyin.

Ardından, ücret planını oluşturmak için API'yi kullanırsınız.

Ücret planını oluştururken özel özellikler içeren ücret planının ayrıntılarını belirtirsiniz. Siz ratePlanDetails özelliğinin ayrıntılarını, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans numaralı telefona sesli arama yapın. İçinde bir derecelendirme parametresi değeri belirtirsiniz. Bu parametre, özel etkinliğin özelliğini gönderin. Ayrıca, özel özelliği toplayan bir derecelendirme parametresi değeri de toplam maliyet daha küçüktür.

Ücret planı bölümünü inceleyin. ayrıntıları yapılandırma ayarlarını inceleyin.

Örneğin, aşağıda özel bir özel özellik planına dayalı olarak bir özelliğini (messageSize) tıklayın (öğelere kalın yazı tipiyle bakın).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Aşağıdaki işlem, messageSize adlı özel özellik (öğeye kalın karakterlerle bakın).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based 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": "messageSize",
           "ratingParameterUnit": "MB",
           "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