Ücret planlarını yönetme

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

Aşağıdaki bölümlerde açıklandığı gibi kullanıcı arayüzünü ve API'yi kullanarak ücret planlarını yönetin.

Ücret planları sayfasını keşfetme

Aşağıda açıklandığı şekilde ücret planları sayfasına erişin.

Fiyat planı oluşturma

Fiyat planı oluşturmak için:

1. Fiyat planları sayfasına erişin.
2. +Ücret Planı'nı tıklayın.
3. Üst panelde aşağıdaki alanları yapılandırın:
   

   Alan	Açıklama	Varsayılan	Zorunlu
   Ücret planı adı	Ücret planınızın adı. NOTE: Ad, bir API ürün paketi içinde benzersiz olmalıdır. Aynı ürün paketindeki iki plan aynı ada sahip olamaz.	Yok	Evet
   Ücret planı türü	Ücret planı türü. Açılır listeden bir değer seçin. Geçerli fiyat planı türlerinin listesi için Desteklenen fiyat planı türleri başlıklı makaleyi inceleyin.	Yok	Evet
   Ürün paketi	API ürün paketi. Açılır listeden bir değer seçin. API ürün paketleri hakkında daha fazla bilgi için API ürün paketlerini yönetme başlıklı makaleyi inceleyin. Birden fazla API ürünü içeren bir ürün paketi seçerseniz her API ürünü için ayrı ayrı ücret planları mı yoksa tüm API ürünleri için geçerli olacak genel bir ücret planı mı yapılandıracağınızı seçmeniz gerekir.	Yok	Evet
   Kitle	Fiyat planına erişebilecek kitle. Açılır listeden aşağıdaki değerlerden birini seçin: Herkes: Tüm geliştiriciler. Geliştirici: Geliştirici veya şirket. Geliştiricinin veya şirketin adını girin. Yazmaya başladığınızda, dizeyi içeren geliştiricilerin/şirketlerin listesi açılır listede gösterilir. Açılır listeden geliştiricinin veya şirketin adını tıklayın. Geliştirici kategorisi: Geliştirici kategorisi. Açılır listeden geliştirici kategorisini seçin. Geliştirici kategorilerini yönetme bölümünde açıklandığı gibi, geliştirici kategorilerini gerektiği şekilde yapılandırın.	Herkes	Hayır
   Başlangıç tarihi	Ücret planının yürürlüğe gireceği tarih. Başlangıç tarihi girin veya takvimi kullanarak bir tarih seçin.	Bugün	Hayır
   Bitiş tarihi	Ücret planının sona erdiği tarih. Bitiş tarihi belirtmek için Bitiş Tarihi Var açma/kapatma düğmesini etkinleştirin ve bitiş tarihi girin veya takvimi kullanarak bir tarih seçin. NOT: Fiyat planı, belirtilen tarihte günün sonuna kadar geçerli olur. Örneğin, bir fiyat planının 1 Aralık 2018'de geçerliliğini yitirmesini istiyorsanız endDate değerini 2018-11-30 olarak ayarlamanız gerekir. Bu durumda, fiyat planının süresi 30 Kasım 2018'de günün sonunda dolar ve 1 Aralık 2018'deki tüm istekler engellenir.	Yok	Hayır
   Portallar tarafından görülebilir	Fiyat planının herkese açık mı yoksa gizli mi olacağını ayarlayın. Herkese açık ve özel indirim planları başlıklı makaleyi inceleyin.	Etkin	Hayır

4. Fiyat planı için ücretleri yapılandırın. Bir fiyat planı için ücret yapılandırma başlıklı makaleyi inceleyin.
   NOTE: Ayarlanabilir bildirim planları için geçerli değildir.
5. Birden fazla API ürünü içeren bir ürün paketi seçerseniz Belirli veya genel fiyat planı bölümünde aşağıdaki tercihleri ayarlayın:
   NOT: Bu adım, ayarlanabilir bildirim planları için geçerli değildir.
   

   Alan	Açıklama	Varsayılan
   Her ürünü ayrı ayrı yapılandırma	Her API ürünü için ayrı bir ücret planı yapılandırılıp yapılandırılmayacağını belirten işaret.	Devre dışı
   Her ürünün ücretsiz sürüm teklifini ayrı ayrı yapılandırma	Her API ürünü için ücretsiz plan yapılandırılıp yapılandırılmayacağını belirten işaret.	Devre dışı
   Ürün seçin	İşaretlerden birini veya her ikisini de etkinleştirirseniz açılır listeden her ürünü ayrı ayrı seçip ücret planı ayrıntılarını yapılandırmanız gerekir. NOTE: Ürün paketindeki tüm ürünleri yapılandırdığınızdan emin olun.	Yok

6. Seçilen ücret planı türüne göre ücret planı ayrıntılarını yapılandırın:
   
   • Freemium
   • Fiyat listesi
   • Gelir paylaşımı
   • Ayarlanabilir bildirim
7. Aşağıdakilerden birini tıklayın:
   

   Düğme	Açıklama
   Taslak olarak kaydet	Fiyat planını taslak olarak kaydedin. Fiyat planı, siz yayınlayana kadar uygulama geliştiricilere görünmez. Taslak fiyat planındaki herhangi bir alanı düzenleyebilirsiniz.
   Yeni Planı Yayınla	Planı yayınlayın. NOTE: Bir fiyat planını yayınladıktan sonra, bitiş tarihi ayarlanmamışsa yalnızca bitiş tarihini değiştirebilirsiniz. Yayınlanan bir fiyat planını silemezsiniz ancak Yayınlanan bir fiyat planının geçerliliğini sona erdirme başlıklı makalede açıklandığı gibi fiyat planının geçerliliğini sona erdirebilir ve yerine gelecekteki bir fiyat planını kullanabilirsiniz.

8. Para Kazandırma Sınırları Kontrolü politikasını, ücret planına dahil edilen API ürünleriyle ilişkili API proxy'lerine ekleyin. Para Kazandırma Sınırları Kontrolü politikası, API proxy'lerine para kazandırma sınırları uygular ve hataların analiz ve para kazanma raporlarına doğru şekilde yansıtılmasını sağlar. Daha fazla bilgi için API proxy'lerinde para kazanma sınırlarını zorunlu kılma başlıklı makaleyi inceleyin.

Fiyat planını düzenleme

Taslak fiyat planındaki tüm alanları (Ürün Paketi, tür ve kitle hariç) düzenleyebilirsiniz. Bir fiyat planını yayınladıktan sonra yalnızca bitiş tarihi belirtilmemişse bitiş tarihini düzenleyebilirsiniz.

Bir fiyat planını düzenlemek için:

1. Fiyat planları sayfasına erişin.
2. Düzenlemek istediğiniz fiyat planının satırını tıklayın.
   Ücret planı paneli gösterilir.
3. Gerekirse ücret planı alanlarını düzenleyin.
   NOTE: Bir fiyat planını yayınladıktan sonra, bitiş tarihi ayarlanmamışsa yalnızca bitiş tarihini değiştirebilirsiniz.
4. Aşağıdakilerden birini tıklayın:

   Düğme	Açıklama
   Taslağı Güncelle (taslak fiyat planları)	Fiyat planını taslak olarak kaydedin. Fiyat planı, siz yayınlayana kadar uygulama geliştiricilere görünmez. Taslak fiyat planındaki herhangi bir alanı düzenleyebilirsiniz.
   Taslağı Yayınla (taslak ücret planları)	Ücret planını yayınlayın. NOTE: Bir fiyat planını yayınladıktan sonra, bitiş tarihi ayarlanmamışsa yalnızca bitiş tarihini değiştirebilirsiniz. Yayınlanan bir fiyat planını silemezsiniz ancak Yayınlanan bir fiyat planının geçerliliğini sona erdirme başlıklı makalede açıklandığı gibi fiyat planının geçerliliğini sona erdirebilir ve yerine gelecekteki bir fiyat planını kullanabilirsiniz.
   Güncellenen bitiş tarihi (yayınlanan fiyat planları)	Yayınlanmış bir planın bitiş tarihini ayarlama NOTE: Yayınlanmış bir ücret planı için bitiş tarihi belirlendikten sonra bu tarih değiştirilemez.

Taslak ücret planını silme

Artık gerekli değilse taslak fiyat planını silin.

NOT: Yayınlanmış bir fiyat planını silemezsiniz.

Taslak fiyat planını silmek için:

1. Fiyat planları sayfasına erişin.
2. İmlecinizi, silmek istediğiniz fiyat planının üzerine getirerek işlemler menüsünü görüntüleyin.
3. simgesini tıklayın.
4. İşlemi onaylamak için Sil'i tıklayın.

API'yi kullanarak ücret planlarını yönetme

Aşağıdaki bölümlerde, API kullanarak fiyat planlarının nasıl yönetileceği açıklanmaktadır.

API'yi kullanarak ücret planları oluşturma

Ücret planı oluşturmak için /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans adresine bir POST isteği gönderin. Burada {monetizationpackage_id}, ücret planını oluşturduğunuz API ürün paketinin kimliğidir (API ürün paketini oluşturduğunuzda yanıt içinde kimlik döndürülür).

Bir fiyat planı oluşturduğunuzda istek gövdesinde aşağıdakileri belirtmeniz gerekir:

• Kuruluş Kimliği
• API ürün paketi kimliği
• Ücret planının adı
• Ücret planının açıklaması
• Ücret planının kapsamı (tüm geliştiriciler için mi yoksa yalnızca belirli bir geliştirici, şirket veya geliştirici kategorisi için mi geçerli olduğu)
• Ücret planının geçerli olacağı tarih
• Ücret planının para birimi
• Ücret planının yayınlanıp yayınlanmayacağı
• Fiyat planının herkese açık mı yoksa gizli mi olduğu

Ödemenin vadesi (örneğin, 30 gün) gibi isteğe bağlı olarak belirtebileceğiniz başka ayarlar da vardır. Fiyat planları için yapılandırma özellikleri başlıklı makaleyi inceleyin.

Birden fazla ürün içeren bir API ürün paketi için ücretler hariç bir ücret planı oluşturursanız planı ürün paketindeki belirli bir ürüne uygulayabilirsiniz. Bunu, talepte ürünü tanımlayarak yapabilirsiniz. Ürün belirtmezseniz plan, API ürün paketindeki tüm ürünlere uygulanır.

Aşağıdaki bölümlerde fiyat planlarının nasıl oluşturulacağı açıklanmaktadır:

• API'yi kullanarak standart ücret planı oluşturma
• API'yi kullanarak geliştirici veya şirket ücret planı oluşturma
• API'yi kullanarak geliştirici kategorisi ücret planı oluşturma
• API'yi kullanarak API ürününe özel ücret planı oluşturma
• API'yi kullanarak fiyat planını herkese açık veya özel olarak ayarlama

API'yi kullanarak standart ücret planı oluşturma

Standart bir fiyat planı oluşturmak için aşağıdaki örnekte gösterildiği gibi type özelliğini STANDARD olarak ayarlayın.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

API'yi kullanarak geliştirici veya şirket ücret planı oluşturma

Ücret planını belirli bir geliştiriciye veya şirkete uygulamak için type değerini Developer olarak ayarlayın. Ayrıca, istekte geliştiriciyi veya şirketi tanımlamanız, kimliği, yasal adı ve geliştiricinin veya şirketin adını belirtmeniz gerekir.

Örneğin, aşağıdaki alıntı Dev Five geliştiricisi için bir fiyat planı oluşturur:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

API'yi kullanarak geliştirici kategorisi ücret planı oluşturma

Ücret planını bir geliştirici kategorisine uygulamak için type değerini Developer_Category olarak ayarlayın. İstekle birlikte geliştirici kategorisini de tanımlamanız gerekir. Örneğin:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

API'yi kullanarak API ürününe özel ücret planı oluşturma

Birden fazla API ürünü içeren API ürünü paketleri için ücret planı oluştururken API ürünlerinin ücret planı ayrıntılarını ayrı ayrı belirtebilirsiniz.

Örneğin, aşağıdaki kod iki API ürünü içeren bir gelir paylaşımı planı oluşturur:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

my-package API ürün paketine bir API ürünü eklemek için API ürününe özel fiyat planlarıyla bir API ürün paketine API ürünü ekleme bölümünde açıklandığı gibi, API ürününün fiyat planı ayrıntılarını istek gövdesine eklemeniz gerekir.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

API'yi kullanarak ücret planını herkese açık veya özel olarak ayarlama

Ücret planı oluştururken istek gövdesindeki isPrivate özelliğini kullanarak planın herkese açık mı yoksa özel mi olacağını belirtebilirsiniz. true olarak ayarlanırsa fiyat planı gizli olur. Daha fazla bilgi için Herkese açık ve özel indirim planları başlıklı makaleyi inceleyin.

Örneğin, aşağıdaki kod özel bir fiyat planı oluşturur:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

API'yi kullanarak ücret planı yayınlama

Bir fiyat planını yayınlamak için fiyat planını oluştururken published özelliği değerini "true" olarak ayarlayın. Geliştiriciler, planın startDate özelliğinde belirtilen tarihten itibaren fiyat planını görüntüleyebilir.

Örneğin, aşağıda bir fiyat listesi planı oluşturulup yayınlanmaktadır (isteğin yalnızca bir kısmı gösterilmektedir):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

API'yi kullanarak ücret planı taslağı kaydetme

Bir fiyat planını yayınlamadan kaydetmek için fiyat planını oluştururken published özelliği değerini false olarak ayarlayın.

Örneğin, aşağıda bir fiyat listesi planı oluşturulup taslak olarak kaydedilmektedir (isteğin yalnızca bir kısmı gösterilmektedir):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

API'yi kullanarak ücret planı taslağını düzenleme

Ücret planı taslağını güncellemek için /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id} adresine bir PUT isteği gönderin. Burada {package_id}, API paketinin tanımlayıcısı, {plan_Id} ise ücret planının tanımlayıcısıdır. Güncelleme yaptığınızda istek gövdesinde güncellenen ayarları ve ücret planının kimliğini belirtmeniz gerekir. Bir ücret planı ücretini güncellerseniz ücret planı ücretinin kimliğini de belirtmeniz gerekir. Örneğin, aşağıdaki istek, kimliği location_flat_rate_card_plan olan bir ücret planındaki ücret planı ücretini günceller (güncelleme vurgulanmıştır):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "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": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "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/location_flat_rate_card_plan" \
-u email:password

Yanıtta güncellenmiş fiyat planı fiyatı yer alıyor (yanıtın yalnızca bir kısmı gösteriliyor):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

API'yi kullanarak ücret planlarını görüntüleme

Aşağıdaki bölümlerde açıklandığı gibi, para kazanma API'sini kullanarak fiyat planlarını görüntüleyebilirsiniz.

• API'yi kullanarak bir kuruluşun tüm fiyat planlarını görüntüleme
• API kullanarak bir API ürün paketi için tüm ücret planlarını görüntüleme
• API'yi kullanarak API ürün paketi için ücret planını görüntüleme
• API'yi kullanarak bir geliştiricinin tüm etkin ücret planlarını görüntüleme
• API'yi kullanarak bir geliştirici için kabul edilen ücret planını görüntüleme
• API'yi kullanarak bir API ürünü içeren, geliştirici için kabul edilmiş bir ücret planını görüntüleme
• API'yi kullanan bir geliştirici tarafından kabul edilen tüm fiyat planlarını görüntüleme

API'yi kullanarak bir kuruluşun tüm ücret planlarını görüntüleme

Bir kuruluşun tüm ücret planlarını görüntülemek için /mint/organizations/{org_name}/rate-plans adresine bir GET isteği gönderin. Burada {org_name}, kuruluşunuzun adıdır.

Sonuçları filtrelemek için aşağıdaki sorgu parametrelerini iletebilirsiniz:

Örneğin:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

API'yi kullanarak bir API ürün paketi için tüm ücret planlarını görüntüleme

Bir API paketinin tüm ücret planlarını görüntülemek için /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans adresine bir GET isteği gönderin. Burada {package_id}, API paketinin kimliğidir (para kazanma paketi oluşturduğunuzda paket kimliği döndürülür).

Varsayılan olarak, sonuçlarda yalnızca etkin, herkese açık ve standart fiyat planları döndürülür. Şunları ekleyin:

• Taslak veya süresi dolmuş fiyat planları için current sorgu parametresini false olarak ayarlayın (örneğin, ?current=false).
• Özel indirim planları için showPrivate sorgu parametresini true olarak ayarlayın (örneğin, ?showPrivate=true).
• Tüm standart ücret planları, standard sorgu parametresini true olarak ayarlayın (örneğin, ?standard=true).

Örneğin:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

API'yi kullanarak API paketi için ücret planını görüntüleme

Bir API paketinin ücret planını görüntülemek için /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} adresine bir GET isteği gönderin. Burada {package_id}, API paketinin kimliği, {plan_id} ise ücret planının kimliğidir (para kazanma paketi oluşturduğunuzda paket kimliği, ücret planı oluşturduğunuzda ise ücret planı kimliği döndürülür).

Örneğin:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

Aşağıda, yanıta dair bir örnek verilmiştir:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

API'yi kullanarak bir geliştiricinin tüm etkin fiyat planlarını görüntüleme

Bir geliştiricinin tüm etkin ücret planlarını görüntülemek için /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans adresine bir GET isteği gönderin. Burada {developer_id}, geliştiricinin e-posta adresidir.

Sonuçları filtrelemek için aşağıdaki sorgu parametrelerini iletebilirsiniz:

Örneğin:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

Aşağıda, yanıta dair bir örnek verilmiştir:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

API'yi kullanan bir geliştirici için kabul edilen ücret planını görüntüleme

Bir geliştiricinin etkin ücret planını görüntülemek için şu adrese bir GET isteği gönderin: /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}, burada {developer_id}, geliştiricinin e-posta adresi ve {developer_rateplan_id}, yayınlanan ücret planını kabul ettiğinizde yanıtta döndürülen kabul edilmiş ücret planının kimliğidir.

Örneğin:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

Aşağıda, yanıta dair bir örnek verilmiştir:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

API'yi kullanarak bir API ürünü içeren, geliştirici için kabul edilmiş bir ücret planını görüntüleme

Bir API ürünü içeren bir geliştirici için kabul edilen ücret planını görüntülemek üzere /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product adresine bir GET isteği gönderin. Burada {developer_id}, geliştiricinin kimliği, /{product_id} ise ürünün kimliğidir.

Varsayılan olarak, sonuçlarda yalnızca herkese açık bir fiyat planı döndürülür. Özel indirim planını göstermek için showPrivate sorgu parametresini true olarak ayarlayın (örneğin, ?showPrivate=true).

Örneğin:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

API'yi kullanan bir geliştirici tarafından kabul edilen tüm ücret planlarını görüntüleme

Bir geliştirici tarafından kabul edilen ücret planlarını görüntülemek için /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans adresine bir GET isteği gönderin. Burada {developer_id}, geliştiricinin kimliğidir.

Sonuçları filtrelemek için aşağıdaki sorgu parametrelerini iletebilirsiniz:

Örneğin:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

Aşağıda, yanıta dair bir örnek verilmiştir:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

API'yi kullanarak ücret planı taslağı silme

Bir ücret planı taslağını silmek için /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} adresine bir DELETE isteği gönderin. Burada {plan_Id}, silinecek ücret planının tanımlayıcısı, {package_id} ise ücret planının API paketinin tanımlayıcısıdır. Örneğin:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Ücret planları için yapılandırma özellikleri

API kullanarak ücret planı oluştururken aşağıdaki yapılandırma ayarlarını belirtebilirsiniz.

Ücret planı ayrıntıları için yapılandırma özellikleri

Ücret planı oluştururken aşağıdaki yapılandırma özelliklerinden herhangi birini ratePlanDetails dizisinin bir parçası olarak belirtebilirsiniz.