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

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

Giriş

Bazı durumlarda, işlem sayıcılarının bir değişkene veya özel değere dayalı olması gerekebilir. Ö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.

Özel özelliklerle ücret planlarını kullanarak bir API çağrısının mesajında sayaç görevi gören ve işlem sayılarını ve ödemeleri hesaplamak için kullanılan bir değer tanımlayabilirsiniz.

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

• Özel özelliklere sahip ücret listesi
• Özel özellikle ayarlanabilir bildirim

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

Özel özellik hesaplamalarını anlama

Özel özellik değerinin ücret planı işlem sayıları ve ödemelerine nasıl dahil edileceği, aşağıdaki tabloda özetlendiği gibi ödeme modeline bağlıdır.

Şarj modeli	Özel özellik hesaplaması
Sabit ücret ve hacme göre bantlandırılmış	custom attribute number * rate = charge to developer Sabit ücret için özel özellik numarası, ücretle çarpılan işlem sayısı olur. Hacim bandı için bir banttaki işlem sayısı, özel özellik sayısı kadar artar ve geliştiriciden bu işlem sayısı kadar ücret alınır. Örneğin, mesajdaki özel özellik değeri 10 ise geliştiriciden 10 işlem için ücret alınır ve mevcut bant sayısına 10 işlem eklenir. Geliştiricinin mevcut bantta yalnızca 6 işlemi varsa 6, ilgili bantın oranıyla çarpılır. Kalan 4 tanesi bir sonraki banda gider ve bu bandın oranıyla çarpılır. Hacim bandına ayrılmış bir planda, son hacim bandının sınırı varsa ("sınırsız" değilse) ve bir işlem bu sınırı aşarsa iki şey olur: Geliştirici, "üzerinde" olan ücreti ücretsiz olarak alır. Plan dönemi sıfırlanana kadar geliştirici uygulamasının API'ye başka çağrılar yapması engellenir. Planların ne zaman sıfırlandığıyla ilgili ayrıntılar için Yinelenen ücretler ne zaman alınır ve paket planları ne zaman sıfırlanır? başlıklı makaleyi inceleyin.
Paketler	Paketler işleme göre değil gruba göre ücretlendirildiğinden aşağıdaki hesaplama yapılır: custom attribute number = amount added to bundle count Örneğin, mesajdaki özel özellik numarası 10 ise pakette kullanılan işlem sayısına 10 eklenir. Geliştiricinin mevcut paketinde yalnızca 6 işlem kalmışsa bu paket doldurulur ve sonraki paket sayısı 4 artar. Bir sonraki paketin ücreti (varsa) alınır. Son paketin bir sınırı varsa ("sınırsız" değilse) ve bir işlem bu sınırı aşarsa iki şey olur: Geliştirici, "fazla" tutarı ücretsiz alır. Plan dönemi sıfırlanana kadar geliştirici uygulamasının API'ye başka çağrılar yapması engellenir. Planların ne zaman sıfırlandığıyla ilgili ayrıntılar için Yinelenen ücretler ne zaman alınır ve paket planları ne zaman sıfırlanır? başlıklı makaleyi inceleyin.
Ayarlanabilir bildirimler	Ayarlanabilir bildirim için aşağıdaki hesaplama yapılır: custom attribute number = amount added to transaction count Örneğin, mesajdaki özel özellik numarası 10 ise toplam işlem sayısına 10 eklenir.

Ücret planının özel özellik değerini alacağı yer

İşlem Kaydı Politikası (API ürün paketinde), para kazanma özelliğinin özel özellik değeri için mesajda nereye bakacağını belirtir. Özel özelliği, API ürün paketinin işlem kaydetme politikasının Özel Özellikler bölümünde tanımlarsınız.

Ardından, özel özelliğin tanımlandığı işlem kaydı politikasını içeren bir API ürün paketi oluşturduktan sonra ücret planında bu özel özelliği seçebilirsiniz.

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

1. 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 kaydı politikasına, ücret planlarını tanımlamak için kullanılacak özel özellikleri ekleyin.
3. API ürün paketi için ücret kartı veya ayarlanabilir bildirim türündeki bir ücret planı oluşturun ve bir özel ücretlendirme parametresi belirtin.

Aşağıdaki şekilde, işlem kaydetme politikasında tanımlanan özel özellik ile ücret listesi planı yapılandırması arasındaki ilişki gösterilmektedir. Özel özellik ücret planı ilişkisine sahip ayarlanabilir bildirim benzerdir ancak hacim bantlı değer geçerli değildir.

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

İşlem kaydı politikası, özel özellik değerini yanıt üst bilgisi, yanıt gövdesi veya yanıttaki önceden tanımlanmış akış değişkenleri gibi çeşitli yerlerde arayabilir. (Başarılı bir yanıt alana kadar işlem resmi olmadığından istek kullanılamaz.) Aşağıda, mesaja sayısal değeriyle birlikte bir yanıt üst bilgisi eklemeyi gösteren örnekler verilmiştir. Her iki durumda da, Mesaj Atama Politikası'nı değişkenlerle birlikte kullanırız.

Yanıt başlığına istek yükü boyutunu ekleme

Her mesaj isteğinde, istek yükündeki bayt sayısını içeren bir client.received.content.length değişkeni bulunur. Proxy uç noktası yanıtına bir İleti Ata politikası ekleyerek, uzunluk değerini içeren messageSize adlı bir yanıt üstbilgisi oluşturabiliriz:

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

Üstbilgiye uygulama özel özelliği değeri ekleme

Benzer şekilde, bir uygulamadaki özel bir özelliğin değerini içeren bir başlık oluşturabiliriz. Örneğin, her geliştirici uygulamasına apprating adlı bir özel özellik eklerseniz aşağıdaki gibi:

Doğrulama API Anahtarını (para kazanma için gereklidir) kullanırken bu değer, verifyapikey.{policy_name}.apprating adlı bir değişkende depolanır. Proxy uç noktası yanıtına eklenmiş mesaj atama politikasını kullanarak, uygulamanın apprating değerini içeren apprating adlı bir başlık oluşturabilirsiniz:

<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 ayarı dışında, ücret planı normalde yaptığınız gibi (özel özellik içermeyen ücret planları için) ayarlanır ancak aşağıdaki şartlara uymalıdır.

Kullanıcı arayüzünü kullanarak ücret listesi planını özel özellikle 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 bir bildirim planı yapılandırma

Ayarlanabilir bildirim planlarını aşağıda açıklandığı şekilde özel özelliklerle yapılandırın.

API'yi kullanarak özel özelliklere sahip bir ü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şlem kaydı politikasına, ücret planlarını tanımlamak için kullanılacak özel özellikleri ekleyin. Ayrıntılar için bu konunun girişine ve İşlem kaydı politikası oluşturma başlıklı makaleye bakın. API paketine dahil etmek istediğiniz her API ürünü için bu işlemi yapın.
2. API ürünleri ve işlem kaydı politikaları tam istediğiniz şekilde yapılandırıldıktan sonra ü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 özelliklerle ücret planının ayrıntılarını belirtirsiniz. ratePlanDetails özelliğinde ayrıntıları, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans çağrısının istek gövdesinde belirtirsiniz. Ayrıntılar bölümünde, özel özelliğin adını tanımlayan bir derecelendirme parametresi değeri belirtirsiniz. Ayrıca, özel özelliği belirli bir zaman aralığında toplayan bir derecelendirme parametresi değeri de belirtebilirsiniz.

Ücret planı ayrıntı seçeneklerinin tam listesi için Ücret planı ayrıntıları yapılandırma ayarları bölümüne bakın.

Örneğin, aşağıdaki kod, messageSize adlı özel bir özelliğe dayalı Özel Özellik planı içeren bir Fiyat Kartı oluşturur (kalın yazılmış öğelere 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 kod, messageSize adlı bir özel özelliğe dayalı Özel Özellik ücret planı içeren Ayarlanabilir Bildirim oluşturur (kalın yazılmış öğeye 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