Ücret listesi planını yapılandırın

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

Giriş

Ücret listesi planında, geliştiriciden her işlem için ödeme alınır. Bu tür bir plan için ek ayrıntılar (ör. şarj modeli ve şarj modelinin fiyatı) sağlamanız gerekir.

İsteğe bağlı olarak, API paketi yerine tek tek ürünler için bir freemium plan belirtebilirsiniz. Bunu yalnızca ürüne özel bir plan için yapabilirsiniz.

Yinelenen ücretler ne zaman alınır ve paket planları ne zaman sıfırlanır?

Ücret planlarında yinelenen ücretlerin yanı sıra API paketleri (Hacme Bantlı ve Paket planları) yer alabilir. Her ikisi de ücretlerin alındığı ve paket planlarının sıfırlandığı belirli zamanları kapsar. Aşağıdaki tabloda, yinelenen ücretlerin ne zaman tahsil edildiği ve paket sayılarının ne zaman sıfırlandığı açıklanmaktadır. Geliştirici uygulamalarının belirli bir işlem sınırına ulaştıkları için daha fazla API çağrısı yapması engellenirse API çağrısı sayılarının sıfıra sıfırlandığı ve uygulamaların tekrar çağrı yapmaya başlayabildiği zamanlardır.

Planda...	...bu olur
Ay olarak ayarlanmış sıfır olmayan yinelenen ücret Hacim bandı veya paket planı	Yinelenen ücret ve paket planı sıfırlaması ayın ilk günü gerçekleşir (varsayılan). Belirli bir günde aylık yineleme için yönetim API'sini kullanarak bir ücret planı oluşturun ve RecurringStartUnit mülkü ile günü belirtin. Bu işlem için API'yi kullanarak ücret planları oluşturma başlıklı makaleyi inceleyin.
Hafta olarak ayarlanmış sıfır olmayan yinelenen ücret Hacim bandı veya paket planı	Yinelenen ücret ve paket planı, geliştiricinin ücret planı başlangıç tarihinden sonraki 7 günde bir sıfırlanır.
Gün olarak ayarlanmış sıfır olmayan yinelenen ücret Hacim Bantlı veya Paket planı	Yinelenen ücret ve paket planı sıfırlaması, geliştiricinin ücret planı başlangıç tarihinden itibaren X günde bir gerçekleşir.
Yinelenen ücret yok (veya sıfır dolar) Hacim bandı veya paket planı	Paket planları, ücret kartında tanımlanan Toplama Tabanı'na göre sıfırlanır. Örneğin, bir geliştirici ayın 19'unda bir ücret planı başlatırsa ve toplama temeli 1 ay ise paket kullanımı her ay 19'unda sıfırlanır. Ayın gününün her zaman aynı olmayabileceğini unutmayın. Örneğin, bir ücret planı 31 Aralık'ta başlıyorsa sıfırlama tarihi, Şubat ayında yalnızca 28 gün olduğundan artık yıl olmayan bir Şubat ayında 28. gün olur. Ayın 28'i, bir sonraki sıfırlama günü olarak kalır.

Kullanıcı arayüzünü kullanarak ücret listesi planlarını yapılandırma

Fiyat listesi planlarını aşağıda açıklandığı şekilde yapılandırın.

API'yi kullanarak ücret kartı planını yapılandırma

Aşağıdaki bölümlerde açıklandığı şekilde, ücret listesi planı ayrıntılarını API'yi kullanarak yapılandırın.

API'yi kullanarak ücret kartı planı ayrıntılarını belirtme

Ücret planını oluştururken ücret listesi planı ayrıntılarını belirtirsiniz. Ayrıntıları, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans çağrısında istek gövdesinde ratePlanDetails mülkünde belirtirsiniz. ratePlanDetails mülkünde belirttiğiniz değerler, seçtiğiniz ücretlendirme modeline (sabit ücret, hacme göre bantlı veya paketler) bağlıdır.

Sabit ücretli şarj modelini belirtme

Sabit ücretli ödeme modelini uygulamak için ücret planı ayrıntılarında şunları belirtirsiniz:

• Ücret planının işlemlere (VOLUME) veya özel bir özelliğe (örneğin, MINT_CUSTOM_ATTRIBUTE_1) dayalı olduğunu belirten bir puan parametresidir. VOLUME, varsayılan değerdir.
• Oran birim başına sabit olduğunu (yani, hacim bantlı veya paket ücretlendirme modelinde olduğu gibi işlem hacmine bağlı olmadığını) belirten bir ölçüm türü (UNIT).
• Ödemenin yapılması gereken dönem (örneğin, 30 gün).
• Kuruluşunuzun kimliği.
• Şirketinizin kullandığı "temel" veya muhasebe para birimi.
• Ücretin nasıl hesaplandığıyla ilgili ayrıntılar sağlayan bir ücret planı ücreti. Ücretlendirme modeli sabit bir ücrete dayalı olduğundan yalnızca bir ücret planı ücreti belirtirsiniz.

Ücret planı ücretinde şunları belirtirsiniz:

• Ücret planı ücretinin türü (RATECARD).
• Planın ücreti. Örneğin, 0, 10 değerini belirtirseniz ve para birimi ABD doları ise geliştiriciden her işlem için 0,10 ABD doları ücret alınır (veya işlemde aktarılan bayt sayısı gibi özel bir özelliğe göre geliştiriciden belirtilen sayıda baytın iletimi için 0, 10 ABD doları ücret alınır).
• Oran uygulamasının başlangıç birimi (0). Bu, oranın ilk işlemden başlayarak her işleme uygulandığı anlamına gelir.

Tarife planı ayrıntısı seçeneklerinin tam listesi için Tarife planı ayrıntısı yapılandırma ayarları başlıklı makaleyi inceleyin.

Örneğin, aşağıdaki kod sabit bir ücretlendirme modeli içeren bir ücret kartı planı oluşturur. Oran, her işlem için 0,10 ABD doları olarak belirlenir. Ödemenin son tarihi 30 gündür. (Ücret listesiyle ilgili ayrıntılar vurgulanmıştır.)

curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     "currency": {
      "id" : "usd"
     },     
     "description": "Flat rate card plan",
     "displayName" : "Flat rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",     
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "paymentDueDays": "30",      
      "meteringType": "UNIT",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.10",
        "startUnit": "0"       
       }      
      ], 
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

Hacim bantlı şarj modeli belirtme

Hacim bantlı modelde, bir veya daha fazla ücret planı ücretini içeren ücret planı ayrıntılarını belirtirsiniz; her ücret, bir "hacim aralığına", yani bir işlem hacmi aralığına (veya aktarılan bayt sayısı gibi özel bir özelliğe dayalı bir aralık) uygulanır. Bu plan türü genellikle geliştiricileri daha yüksek hacimli bantlarda indirimli fiyatlar sunarak daha yüksek hacim oluşturmaya teşvik etmek için oluşturulur.

Ücret planı ücretlerine ek olarak ücret planı ayrıntılarında aşağıdakileri de belirtirsiniz:

• Ücret planının işlemlere (VOLUME) veya özel bir özelliğe (örneğin, CUSTOM_ATTRIBUTE_1) dayalı olduğunu belirten bir puan parametresidir. VOLUME, varsayılan değerdir.
• Ücretin işlem hacmine göre belirlendiğini belirten bir ölçüm türü (VOLUME) (yani sabit ücretli ödeme modelinde olduğu gibi işlem başına sabit bir ücret değildir).
• Son ödeme tarihi (örneğin, 30 gün).
• Kuruluşunuzun kimliği.
• Şirketinizin kullandığı "temel" veya muhasebe para birimi.
• İşlem hacminin (veya özel özellikle ilgili hacmin) toplandığı süreyi birlikte belirten bir süre ve süre türü. Buna "toplama bazı" da denir. Geçerli hacim bandını belirlemek için işlem hacmi, toplama bazında (ör. 1 ay) toplanır.
• Geçerli ses bandını belirlemek için kullanılan toplama sayaçları.

Her ücret planı fiyatı için şunları belirtirsiniz:

• Ücret planı ücretinin türü (RATECARD).
• Planın ücreti. Örneğin, 0, 10 değerini belirtirseniz ve para birimi ABD dolarıysa geliştiriciden her işlem için 0,15 ABD doları alınır (veya bir işlemde aktarılan bayt sayısı gibi özel bir özelliğe dayanıyorsa geliştiriciden belirtilen bayt sayısını aktarma için 0, 15 ABD doları alınır).
• Ses bandının başlangıç ve bitiş birimi. Başlangıç birimi, ses bandının alt sınırını, bitiş birimi ise ses bandının üst sınırını belirtir. Örneğin, başlangıç birimi 0 ve bitiş birimi olarak 1.000 belirtirseniz hacim bandı toplama döneminde en fazla 1.000 işlemi kapsar. Para birimi ABD doları ise toplama dönemi 1 ay ve ilk 1.000 işlemin ücreti 0,15 ise geliştiriciden, ayda en fazla 1.000 işlem için işlem başına 0,15 ABD doları tutarında ödeme alınır.
  
  Paketlerin ne zaman sıfırlandığı hakkında ayrıntılı bilgi için Yinelenen ücretler ne zaman alınır ve paket planları ne zaman sıfırlanır? başlıklı makaleyi inceleyin.
  

  Nihai hacim bandı için bitiş birimi belirtmezseniz işlem sayısı söz konusu bandın başlangıç biriminin üzerine çıktıktan sonra bu bandın fiyatı tüm işlemlere uygulanır. Örneğin, son bandın başlangıç birimi 1.000 ise ve bu bant için bir bitiş birimi belirtmezseniz bantın fiyatı, toplama dönemindeki 1.000 işlemden sonraki tüm işlemlere uygulanır.

Ü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, hacim bantlı bir ücretlendirme modeline sahip bir ücret listesi planı oluşturur. Oran, ilk 1.000 işlem için 0,15 ABD doları, 1.000'den fazla işlem için ise 0,10 ABD doları olarak belirlenmiştir. Toplama dönemi 1 aydır. Ödemenin son tarihi 30 gündür. (Ücret listesi ayrıntıları vurgulanmıştır.)

curl -H "Content-Type:application/json" -X POST -d \

'{
     "name": "Volume banded rate card plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },     
     "frequencyDuration": "30",
     "description": "Volume banded rate card plan",
     "displayName" : "Volume banded rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },      
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "0.15",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "0.10",
       "startUnit": "1000"      
      }
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

Paket halinde şarj modelini belirtme

Paket halinde ödeme alma modelinde geliştirici, bir işlem "paketi" (veya iletilen bayt sayısı gibi özel bir özelliğe dayalı bir paket) için (önceden) ödeme yapar. Her paket için bir ücret ve toplama tabanını belirtirsiniz. Toplama tabanı, geliştiricinin paketi kullanabileceği süredir.

Örneğin, ilk paket boyutunun 1 ila 1.000 işlem, ikinci paket boyutunun ise 1.001 ila 2.000 işlem olduğunu varsayalım. Ücret, ilk paket için 50 TL, ikinci paket için 40 TL'dir ve toplama temeli 1'dir. Geliştirici ilk paket için ücret listesi planı satın alırsa ayda 1.000 işlem için 50 ABD doları (önceden) ödeme yapar. Paketin tamamen kullanılıp kullanılmadığına bakılmaksızın geliştiriciden, belirlenen tutarda ödeme alınır. Toplama dönemi sona erdikten sonra planın süresi dolar. Geliştirici paketi tekrar kullanmak isterse planı (ve paketi) tekrar satın alması gerekir.

Ücret planı ayrıntılarında belirttiğiniz bilgiler, temel olarak hacim bantlı ücretlendirme modeli için ücret planı ayrıntılarında belirttiğiniz bilgilerle aynıdır. Farklar aşağıda belirtilmiştir:

• Belirttiğiniz her ücret planı, bir paket içindir (hacim bandı için değil).
• Geliştiriciden son paketteki sınırsız işlemler için sabit bir tutarda ödeme almak istemiyorsanız son paket için bir üst sınır belirtmeniz gerekir.

Tarife planı ayrıntısı seçeneklerinin tam listesi için Tarife planı ayrıntısı yapılandırma ayarları başlıklı makaleyi inceleyin.

Örneğin, aşağıdaki kod, paket halinde ücretlendirme modeli içeren bir ücret listesi planı oluşturur. Ücret, ilk paket için 50 TL (1.000'e kadar işlem) ve ikinci paket için 40 TL (1.000'den fazla ve 2.000'e kadar işlem) olarak belirlenmiştir. Toplama dönemi 1 aydır. Ödemenin yapılması gereken son tarih 30 gündür.

curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Bundled rate plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },    
     "frequencyDuration": "30",
     "description": "Bundled rate plan",
     "displayName" : "Bundled rate plan",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "true",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "STAIR_STEP",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "50",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "40",
       "startUnit": "1000",
       "endUnit": "2000"
      }
      ],
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

API'yi kullanarak ürünler için ayrı ayrı ücretsiz plan belirtme

Ücret listesi planında, API paketi yerine tek bir ürün için ücretsiz sürüm planı oluşturabilirsiniz. Freemium planlar, geliştiricilere bir API ürününü belirli bir süre boyunca veya kullanım miktarına göre ücretsiz olarak kullanma imkanı sunar.

Bir API ürünü için ücretsiz sürüm planı oluşturduğunuzda, ücret kartı plan ayrıntılarında geliştiricinin API ürünü tarafından sağlanan kaynakları ücretsiz olarak kullanabileceği dönemi belirtirsiniz. Dönem aşağıdakilerden birine dayalı olabilir:

• Süre, yani geçerlilik tarihi ile bitiş tarihi arasındaki süre.
• API ürününü içeren işlemlerin sayısı veya işlem kaydı politikasında kaydedilen özel bir özellikle ilgili hacim gibi miktar.

Freemium dönemi miktara dayalıysa bunu freemium birimi sayısı olarak belirtin. Örneğin, aşağıdaki kod, 5.000 birim hacme dayalı bir ücretsiz plan içeren bir ücret listesi planı oluşturur (ücretsiz planla ilgili özellikler vurgulanmıştır).

curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "Flat rate card plan with freemium period",
      "developer":null,
      "developerCategory":null,      
      "advance": "false",
      "currency": {
       "id" : "usd"
      },     
      "description": "Flat rate card plan with freemium period",
      "displayName" : "Flat rate card plan with freemium period",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",     
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "myorg"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
       "aggregateFreemiumCounters" : true,
       "aggregateStandardCounters" : true,
        "id" : "usd"
       },
       "product" : {
        "id" : "location",
        "displayName":"Location"
       },
       "paymentDueDays": "30",      
       "meteringType": "UNIT",
       "organization": {
        "id": "myorg"
       },
       "ratePlanRates": [
        {
         "type": "RATECARD",
         "rate": "0.10",
         "startUnit": "0"       
        }      
       ],
      "freemiumUnit": "5000",
      "freemiumDuration": "0",
      "freemiumDurationType": "DAY",
      "ratingParameterUnit":"MB",
      "customPaymentTerm": "false",
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "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