Ücret planlarını yönetme

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

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

Ücret planları sayfasını keşfetme

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

Edge

Edge kullanıcı arayüzünde ücret planlarını görüntülemek için Ücret Planları sayfasına gidin:

  1. apigee.com/edge adresinde oturum açın.
  2. Sol gezinme çubuğunda Yayınla > Para Kazanma > Ücret Planları'nı seçin.

Ücret Planları sayfası görüntülenir.

Şekilde vurgulandığı gibi Ücret Planları sayfasında şunları yapabilirsiniz:

Klasik Edge (Private Cloud)

Klasik Edge kullanıcı arayüzünü kullanarak ücret planlarını görüntülemek için API Paketleri sayfasına erişin:

  1. http://ms-ip:9000 üzerinde oturum açın. Burada ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.
  2. Üst gezinme çubuğunda Yayınla > Paketler'i seçin.

API Paketleri sayfasında, her paket için tanımlanan ücret planları gösterilir.

Ücret Planları sayfasında şunları yapabilirsiniz:

Ücret planı oluşturma

Ücret planı oluşturmak için:

  1. Ücret Planları sayfasına erişin.
  2. +Ücret Planı'nı tıklayın.
  3. Üst panelde şu alanları yapılandırın:
    Alan Açıklama Varsayılan Gerekli
    Ücret planı adı Ücret planınızın adı.

    NOT: Ad, 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 ücret planı türlerinin listesi için Desteklenen ücret 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 bölümüne bakın.

    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 Ücret planına erişebilen 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ştirici adını veya şirketi girin. Siz yazarken, dizeyi içeren geliştiricilerin/şirketlerin listesi bir açılır listede görüntülenir. 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 gerektiği gibi yapılandırın (Geliştirici kategorilerini yönetme bölümünde açıklandığı gibi).

    		 Herkes Hayır
    Start date (Başlangıç tarihi) Ücret planının geçerli olacağı tarih. Bir 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. Bir bitiş tarihi belirtmek için Bitiş Tarihi Var seçeneğini etkinleştirin, açma/kapatma anahtarını kullanarak bir bitiş tarihi girin veya takvimi kullanarak bir tarih seçin.

    NOT: Ücret planı, belirtilen tarihte günün sonuna kadar geçerli olur. Örneğin, bir ücret planının süresinin 1 Aralık 2018'de sona ermesini istiyorsanız endDate değerini 30.11.2018 olarak ayarlamanız gerekir. Bu durumda, ücret planının süresi 30 Kasım 2018 gün sonunda dolar ve 1 Aralık 2018'deki tüm istekler engellenir.

    		Yok Hayır
    Portallara görünür Ücret planının Herkese Açık veya Gizli olmasını seçin. Herkese açık ve özel indirim planları bölümüne bakın. Etkin Hayır
  4. Ücret planı için ücretleri yapılandırın. Ücret planı için ücretleri yapılandırma bölümünü inceleyin.
    NOT: Ayarlanabilir bildirim planlarında geçerli değildir.
  5. Birden fazla API ürünü içeren bir ürün paketi seçerseniz Belirli veya genel ücret planı bölümünde şu 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 freemium ücretsiz teklifini ayrı ayrı yapılandır Her API ürünü için freemium ücretsiz plan yapılandırılıp yapılandırılmayacağını belirten işaret. Devre dışı
    Bir ürün seçin İşaretlerden birini veya her ikisini de etkinleştirirseniz açılır listeden her ürünü tek tek seçmeniz ve ücret planı ayrıntılarını yapılandırmanız gerekir.

    NOT: Ü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:
  7. Aşağıdakilerden birini tıklayın:
    Düğme Açıklama
    Taslak olarak kaydet Ücret planını taslak olarak kaydedin.

    Ücret planı, siz yayınlayana kadar uygulama geliştiriciler tarafından görülmez. Taslak ücret planındaki herhangi bir alanı düzenleyebilirsiniz.

    Yeni Plan Yayınla Planı yayınlayın.

    NOT: Bir ücret planını yayınladıktan sonra, bitiş tarihini yalnızca henüz ayarlanmamışsa değiştirebilirsiniz. Yayınlanmış bir ücret planını silemezsiniz ancak ücret planının süresini sona erdirebilir ve Yayınlanmış bir ücret planının süresini sona erdirme bölümünde açıklandığı şekilde bunu gelecekteki bir ücret planıyla değiştirebilirsiniz.

  8. Para Kazanma Sınırları Kontrolü politikasını, ücret planına dahil edilen API ürünleriyle ilişkili API proxy'lerine ekleyin. Para Kazanma Sınırları Kontrolü politikası, API proxy'lerine para kazanma sınırları uygular ve olası hataların analiz ve para kazanma raporlarında doğru şekilde tespit edilmesini sağlar. Daha fazla bilgi için API proxy'lerinde para kazanma sınırlarını zorunlu kılma konusuna bakın.

Ücret planını düzenleme

Ürün Paketi, tür ve kitle dışındaki tüm alanları taslak ücret planında düzenleyebilirsiniz. Bir ücret planı yayınladıktan sonra, yalnızca bitiş tarihini ve yalnızca bitiş tarihi belirtilmediyse bitiş tarihini düzenleyebilirsiniz.

Ücret planını düzenlemek için:

  1. Ücret Planları sayfasına erişin.
  2. Düzenlemek istediğiniz ücret planının satırını tıklayın.
    Ücret planı paneli gösterilir.
  3. Ücret planı alanlarını gerektiği gibi düzenleyin.
    NOT: Bir ücret planı yayınladıktan sonra, bitiş tarihini yalnızca henüz ayarlanmamışsa değiştirebilirsiniz.
  4. Aşağıdakilerden birini tıklayın:
    Düğme Açıklama
    Taslak Güncelleme (taslak ücret planları) Ücret planını taslak olarak kaydedin.

    Ücret planı, siz yayınlayana kadar uygulama geliştiriciler tarafından görülmez. Taslak ücret planındaki herhangi bir alanı düzenleyebilirsiniz.
    Taslağı Yayınlama (taslak ücret planları) Ücret planını yayınlayın.

    NOT: Bir ücret planı yayınladıktan sonra, bitiş tarihini ancak henüz ayarlanmamışsa değiştirebilirsiniz. Yayınlanmış bir ücret planını silemezsiniz ancak ücret planının süresini sona erdirebilir ve Yayınlanmış bir ücret planının süresini sona erdirme bölümünde açıklandığı şekilde bunu gelecekteki bir ücret planıyla değiştirebilirsiniz.
    Güncellenen Bitiş Tarihi (yayınlanan ücret planları) Yayınlanan bir planın bitiş tarihini ayarlayın.

    NOT: Yayınlanan bir ücret planının bitiş tarihi ayarlandıktan sonra bu plan değiştirilemez.

Taslak ücret planını silme

Artık gerekli olmayan bir taslak ücret planını silin.

NOT: Yayınlanmış bir ücret planını silemezsiniz.

Taslak ücret planını silmek için:

  1. Ücret Planları sayfasına erişin.
  2. İşlemler menüsünü görüntülemek için imlecinizi silmek istediğiniz ücret planının üzerine getirin.
  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 kullanılarak ücret planlarının nasıl yönetileceği açıklanmaktadır.

API'yi kullanarak ücret planları oluşturma

Ücret planı oluşturmak amacıyla /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans için bir POST isteği yayınlayın. Burada {monetizationpackage_id}, ücret planını oluşturduğunuz API ürün paketinin kimliğidir (Kimlik, API ürün paketini oluşturduğunuzda yanıtta döndürülür).

Ücret planı oluştururken 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 veya yalnızca belirli bir geliştirici, şirket veya geliştirici kategorisi için geçerli olup olmadığı)
  • Ücret planının yürürlüğe girdiği tarih
  • Ücret planı için para birimi
  • Ücret planının yayınlanıp yayınlanmayacağı
  • Ücret planının herkese açık mı yoksa özel mi olduğu

İsteğe bağlı olarak, ödemenin yapılması gereken süre (örneğin, 30 gün) gibi başka ayarlar da belirtilebilir. Ücret planları için yapılandırma özellikleri bölümüne bakın.

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

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

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

Standart ücret planı oluşturmak için type özelliğini aşağıdaki örnekte gösterildiği gibi 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ştirici veya şirketi de belirtmeniz gerekir. Ayrıca şirketin geliştiricisinin kimliğini, yasal adını ve adını da belirtmeniz gerekir.

Örneğin, aşağıdaki alıntı Dev Five geliştiricisi için bir ücret 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. İstekte geliştirici kategorisini de belirtmeniz 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ğıda iki API ürünüyle gelir paylaşımı planı oluşturulur:

$ 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 ücret planları içeren API ürün paketine API ürünü ekleme bölümünde açıklandığı şekilde API ürünüyle ilgili ücret 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 gizli olarak ayarlama

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

Örneğin, aşağıdaki işlem özel indirim 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

Ücret planı yayınlamak için ücret planını oluştururken published tesis değerini "true" olarak ayarlayın. Geliştiriciler, ücret planını, planın startDate mülkünde belirtilen tarihten itibaren görüntüleyebilirler.

Örneğin, aşağıda bir ücret listesi planı oluşturulur ve yayınlanır (isteğin yalnızca bir kısmı gösterilir):

$ 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 ücret planını yayınlamadan kaydetmek için ücret planını oluştururken published özellik değerini "false" (yanlış) olarak ayarlayın.

Örneğin, aşağıda bir ücret listesi planı oluşturulur ve taslak olarak kaydedilir (isteğin yalnızca bir kısmı gösterilir):

$ 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} için PUT isteği gönderin. Burada{package_id} API paketinin kimliği, {plan_Id} ise ücret planının kimliğidir. Güncellemeyi yaparken, 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ş ücret planı ücreti yer alır (yanıtın yalnızca bir kısmı gösterilir):

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

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

Para kazanma API'sini kullanarak ücret planlarını aşağıdaki bölümlerde açıklandığı şekilde görüntüleyebilirsiniz.

API'yi kullanan 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 aktarabilirsiniz:

Sorgu Parametresi Açıklama
all Tüm ücret planlarının döndürülüp döndürülmeyeceğini belirten işaret. false olarak ayarlanırsa sayfa başına döndürülen ücret planlarının sayısı size sorgu parametresi tarafından tanımlanır. Varsayılan olarak true değerine ayarlanır.
size Sayfa başına döndürülen API paketi sayısı. all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır.
page Döndürmek istediğiniz sayfanın sayısı (içerik sayfalara ayrılmışsa). all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır.

Ö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 paketiyle ilgili tüm ücret planlarını görüntülemek için /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans öğesine bir GET isteği gönderin. Burada {package_id}, API paketinin kimliğidir (paket kimliği, para kazanma paketini oluşturduğunuzda döndürülür).

Varsayılan olarak, sonuçlarda yalnızca etkin, herkese açık ve standart ücret planları döndürülür. Dahil etmek için:

  • Taslak veya süresi dolmuş ücret planları, current sorgu parametresini false olarak ayarlayın (örneğin, ?current=false).
  • Özel indirim planlarında showPrivate sorgu parametresini true olarak ayarlayın (örneğin, ?showPrivate=true).
  • Tüm standart ücret planlarında 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ı 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} için GET isteği gönderin. Burada {package_id}, API paketinin kimliği, {plan_id} ise ücret planının kimliğidir (para kazanma paketini oluşturduğunuzda paket kimliği döndürülür ve ücret planını oluşturduğunuzda ü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ıtla ilgili bir örnek yer almaktadır:

{
   "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 kullanan bir geliştiricinin tüm etkin ücret 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 GET isteği gönderin. Burada {developer_id}, geliştiricinin e-posta adresidir.

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

Sorgu Parametresi Açıklama
all Tüm API paketlerinin döndürülüp döndürülmeyeceğini belirten işaret. false olarak ayarlanırsa sayfa başına döndürülen API paketi sayısı size sorgu parametresi tarafından tanımlanır. Varsayılan olarak false değerine ayarlanır.
size Sayfa başına döndürülen API paketi sayısı. Varsayılan değer 20'dir. all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır.
page Döndürmek istediğiniz sayfanın sayısı (içerik sayfalara ayrılmışsa). all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır.

Ö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ıtla ilgili bir örnek yer almaktadır:

{
  "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ştiricinin kabul ettiği ücret planını görüntüleme

Bir geliştiricinin etkin bir ücret planını görüntülemek için /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} adresine GET isteği gönderin. Burada {developer_id}, geliştiricinin e-posta adresi, {developer_rateplan_id} ise yayınlanan ücret planını kabul ettiğinizde yanıtta döndürülen kabul edilen ü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ıtla ilgili bir örnek yer almaktadır:

{
    "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 kullanan bir API ürünü içeren geliştiricinin kabul ettiği ücret planını görüntüleme

API ürünü içeren bir geliştiricinin kabul edilen ücret planını görüntülemek için /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product adresine 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örüntülemek 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 kullanarak bir geliştirici tarafından kabul edilen tüm ücret planlarını görüntüleme

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 GET isteği gönderin. Burada {developer_id}, geliştiricinin kimliğidir.

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

Sorgu Parametresi Açıklama
all Tüm API paketlerinin döndürülüp döndürülmeyeceğini belirten işaret. false olarak ayarlanırsa sayfa başına döndürülen API paketi sayısı size sorgu parametresi tarafından tanımlanır. Varsayılan olarak false değerine ayarlanır.
size Sayfa başına döndürülen API paketi sayısı. Varsayılan değer 20'dir. all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır.
page Döndürmek istediğiniz sayfanın sayısı (içerik sayfalara ayrılmışsa). all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır.

Ö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ıtla ilgili bir örnek yer almaktadır:

{
  "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ğını silme

Ücret planı taslağını silmek için /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} için DELETE isteği gönderin. Burada {plan_Id} silinecek ücret planının kimliği, {package_id} ise ücret planı için API paketinin tanımlaması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'yi kullanarak ücret planı oluştururken aşağıdaki yapılandırma ayarlarını belirtebilirsiniz.

Ad Açıklama Varsayılan Zorunlu mu?
advance

Yalnızca yinelenen ücretler için geçerlidir. Yinelenen ücretin önceden alınıp alınmayacağını belirten işaret. Geçerli değerler şunları içerir:

  • true: Yinelenen ücret, önceden alınır. Örneğin, dönem 1 ay ise yinelenen ücret, önceki faturalandırma ayı sona erdiğinde oluşturulan faturaya yansıtılır.
  • false: Dönem sonunda yinelenen ücret alınır. Örneğin, dönem 1 ay ise yinelenen ücret geçerli faturalandırma ayı sona erdiğinde faturaya yansıtılır. Bu varsayılan seçenektir.
 false Hayır
contractDuration

contractDurationType ile birlikte planın sözleşme süresi. Örneğin, 6 aylık bir sözleşme süresi belirtmek için contractDuration değerini 6, contractDurationType değerini ise MONTH olarak ayarlayın.

 Yok Hayır
contractDurationType

contractDuration ile birlikte planın sözleşme süresi. Geçerli değerler şunları içerir:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 Yok Hayır
currency

Ücret planı için kullanılan para birimidir. Para birimi için ISO 4217 kodunu belirtin. Örneğin, ABD doları için usd veya İsviçre frangı için chf.

 Yok Evet
description

Ücret planının açıklaması.

 Yok Evet
developer

Geliştirici kimliği (e-posta adresi). Yalnızca geliştirici ücret planları için belirtin.

 Yok Hayır
developerCategory

Geliştirici kategorisi kimliği. Yalnızca geliştirici kategorisi ücret planları için belirtin.

 Yok Hayır
displayName

Ücret planı için kullanıcı dostu görünen ad.

 Yok Evet
earlyTerminationFee

Geliştiricinin planı yenileme süresinden önce sonlandırması durumunda alınan tek seferlik ücret.

 Yok Hayır
endDate

Planın sona erdiği tarih. Geliştiriciler bu tarihten sonra ücret planını görüntüleyemez. Ücret planının belirli bir tarihte sona ermesini istemiyorsanız endDate için boş değer belirtin.

Ücret planı, belirtilen tarihte günün sonuna kadar geçerli olur. Örneğin, bir ücret planının süresinin 1 Aralık 2016'da sona ermesini istiyorsanız endDate değerini 2016-11-30 olarak ayarlamanız gerekir. Bu durumda, ücret planının süresi 30 Kasım 2016'da sona erer ve 1 Aralık 2016'daki tüm istekler engellenir.

NOT: API'yi kullanarak ücret planını görüntülerken endDate zaman damgası YYYY-MM-DD 00:00:00 olarak belirtilir. Bu durum yanıltıcı olabilir.

 Yok Hayır
freemiumDuration

freemiumDurationType ile birlikte freemium ücretsiz dönemin süresi. Örneğin, freemium süresinin 30 gün olduğunu belirtmek için freemiumDuration değerini 30 ve freemiumDurationType değerini DAY olarak ayarlayın.

 Yok Hayır
freemiumDurationType

freemiumDuration ile birlikte freemium ücretsiz dönemin süresi. Geçerli değerler şunları içerir:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 Yok Hayır
freemiumUnit

Freemium ücretsiz miktar. Değer, işlem kaydetme politikasına kaydedilen işlem sayısı veya özel özellikle ilişkili birimlerin sayısı olabilir.

 Yok Hayır
frequencyDuration

Yalnızca yinelenen ücretler için geçerlidir. Yinelenen ücret ödemeleri ile frequencyDurationType arasındaki süre. Örneğin, ücret ödemeleri arasındaki sürenin 30 gün olduğunu belirtmek için frequencyDuration değerini 30, frequencyDurationType değerini ise DAY olarak ayarlayın.

 Yok Hayır
frequencyDurationType Yalnızca yinelenen ücretler için geçerlidir. Yinelenen ücret ödemeleri ile frequencyDuration arasındaki süre. Geçerli değerler şunlardır:
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 Yok Hayır
isPrivate Ücret planının herkese açık mı yoksa gizli mi olduğunu belirten işaret. Varsayılan olarak false (herkese açık) değerine ayarlanır. Daha fazla bilgi için Herkese açık ve özel indirim planları bölümüne bakın. Yok Hayır
monetizationPackage

Ücret planının API ürün paketi kimliği.

 Yok Hayır
name

Ücret planının adı.

 Yok Evet
organization

Ücret planının kuruluş kimliği.

 Yok Evet
paymentDueDays

Yalnızca yinelenen ücretler için geçerlidir. Ücretlerin ödenmesi gereken gün sayısı. Örneğin, ücretlerin 30 gün içinde ödenmesi gerektiğini belirtmek için değeri 30 olarak ayarlayın.

 Yok Hayır
proRate

Yalnızca yinelenen ücretler için geçerlidir. Geliştirici bir ay boyunca bir planı başlattığında veya sona erdiğinde yinelenen ücretin orantılı olup olmadığını belirten işaret. Geçerli değerler şunları içerir:

  • true - Başlangıç ücreti, dönemin sonuna kadar olan gün sayısına (veya dönemde kullanılan gün sayısına) göre hesaplanır.
  • false: Geliştiricinin planı ne zaman başlattığına (veya sona erdirdiğine) bakılmaksızın, tam ilk ücret geliştiriciden alınır. Bu varsayılan seçenektir.
 false Hayır
published

Ücret planının geliştiriciler tarafından görüntülenmek üzere yayınlanıp yayınlanmayacağını belirten işaret. Geçerli değerler şunları içerir:

  • true - Ücret planını yayınlayın.
  • false - Ücret planını yayınlamayın.
 Yok Evet
ratePlanDetails

Ücret planıyla ilgili ayrıntılar (Ücret planı ayrıntıları için yapılandırma özellikleri bölümüne bakın).

 Yok Evet
recurringFee

Geliştirici planı sonlandırana kadar geliştiriciden sürekli olarak alınan ücret.

 Yok Hayır
recurringStartUnit

Yalnızca recurringType, CALENDAR olarak ayarlandıysa geçerlidir. Yinelenen ücretin alınacağı ayın günüdür. Örneğin, yinelenen ücret aylık olarak alınırsa ve recurringStartUnit 1 olarak ayarlanırsa yinelenen ücret her ayın ilk gününde alınır.

 Yok Hayır
recurringType

Yinelenen ücreti planlayın. Geçerli değerler şunları içerir:

  • CALENDAR: Bir takvime göre planlandı.
  • CUSTOM: Özel bir tarih ayarına göre planlandı.
 Yok Hayır
setUpFee

Planın başlangıç tarihinde (yani geliştiricinin planı satın aldığı tarihte) her geliştiriciden alınan tek seferlik ücret.

 Yok Hayır
startDate

Planın başladığı tarih. Geliştiriciler bu tarihten itibaren ücret planını görüntüleyebilir.

 Yok Evet
type

Ücret planının türü. Aşağıdakilerden birini belirtin:

  • STANDARD. Tüm geliştiriciler için geçerlidir.
  • DEVELOPER_CATEGORY. Seçilen bir kategorideki tüm geliştiriciler için geçerlidir.
  • DEVELOPER. Belirli bir geliştirici veya şirket için geçerlidir.
 Yok Evet

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

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

Ad Açıklama Varsayılan Zorunlu mu?
aggregateFreemiumCounters

Bir API ürününün kullanımının serbest aralıkta olup olmadığını belirlemek için toplam sayaçlarının etkinleştirilip etkinleştirilmediğini belirten işaret. Bir ürün için freemium ücretsiz plan oluşturmak amacıyla toplam sayaçların etkinleştirilmesi gerekir. Geçerli değerler şunları içerir:

  • true - Toplam sayaçları etkinleştirme.
  • false - Toplam sayaçları etkinleştirme.
 Yok Hayır
aggregateStandardCounters

Kullanım aralığını belirlemek için toplam sayaçların kullanılıp kullanılmadığını belirten işaret (ücret listesi planı için hacim aralığı gibi). Değer şunlardan biri olabilir:

  • true - Toplam sayaçları kullanın.
  • false - Toplam sayaçları kullanmayın.
 Yok Hayır
aggregateTransactions

NOT: Bu mülk, şu anda para kazanma özelliği tarafından kullanılmadığından yoksayılabilir.

 true Hayır
currency

Para Birimi.

 Yok Hayır
duration

İzin verilen duration değerlerinin 1-24 arasında olduğu durationType ile birlikte hesaplama sıklığı için dönem.

Örneğin, 2 aylık hesaplama sıklığı belirtmek için duration değerini 2, durationType değerini ise MONTH olarak ayarlayın.

 Yok Hayır
durationType

duration ile birlikte hesaplama sıklığına ilişkin dönem. Geçerli tek değer MONTH.

Kullanım örneği için duration adresine bakın.

 Yok Hayır
freemiumDuration

freemiumDurationType ile birlikte tek bir API ürününün freemium ücretsiz dönemi. Örneğin, bir API ürününün ücretsiz kullanım süresinin 30 gün olduğunu belirtmek için freemiumDuration değerini 30, freemiumDurationType değerini de DAY olarak ayarlayın.

 Yok Hayır
freemiumDurationType

freemiumDuration ile birlikte tek bir API ürününün freemium ücretsiz dönemi. Geçerli değerler şunları içerir:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

Örneğin, bir API ürününün ücretsiz üyelik süresinin 30 gün olduğunu belirtmek için freemiumDuration değerini 30, freemiumDurationType değerini ise DAY olarak ayarlayın.

 Yok Hayır
freemiumUnit

Bir API ürünü için ücretsiz kullanım miktarı. Değer, işlem kaydetme politikasına kaydedilen işlem sayısı veya özel özellikle ilişkili birimlerin sayısı olabilir.

 Yok Hayır
meteringType

Ücret listesi planı için ücretlendirme modeli. Geçerli değerler şunları içerir:

  • UNIT - Sabit ücret ödeme modeli.
  • VOLUME - Hacim bantlı şarj modeli.
  • STAIR_STEP - Pakete dahil ödeme modeli.
  • DEV_SPECIFIC - Ayarlanabilir bildirim şarj modeli. Diğer gelir modelleri için geçerli değildir.
 Yok evet
organization

Kuruluş kimliği.

 Yok Hayır
paymentDueDays

Sonradan ödeme geliştirici için son ödeme tarihi. Örneğin, ödemenin son 30 gün içinde olduğunu belirtmek için bu değeri 30 olarak ayarlayın.

 Yok Hayır
product

API ürün bilgileri (ör. no)

 Yok Hayır
ratePlanRates

Ücret planı türü (REVSHARE veya RATECARD), ücret listesi planı için ücret, gelir paylaşımı planı için gelir paylaşımı ve aralık (ücret planı ücretinin geçerli olduğu başlangıç birimi ve bitiş birimi) gibi ücret planı ücret ayrıntıları.

 Yok Evet
ratingParameter

Ücret planının temeli. Ücret planı, işlemlere veya özel bir özelliğe dayanır. Geçerli değerler şunları içerir:

  • VOLUME - Ücret planı, işlemlerin hacmine bağlıdır.
  • custom_attribute - API ürününün işlem kaydetme politikasında tanımlanan ve yalnızca ücret listesi planları için geçerli olan özel bir özelliğin adı. Özel özellik adı VOLUME olarak tanımlanamıyor.
 VOLUME Evet
ratingParameterUnit

ratingParameter. Only required if ratingParameters için geçerli olan birim, özel bir özelliğe ayarlanmış (VOLUME olarak ayarlanmamış).

 Yok Evet
revenueType

Gelir paylaşımı planındaki gelir paylaşımı temeli. Geçerli değerler şunları içerir:

  • GROSS: Gelir paylaşımı, bir işlemin brüt fiyatının belirli bir yüzdesine dayanır.
  • NET: Gelir paylaşımı, bir işlemin net fiyatının belirli bir yüzdesine dayanır.
 Yok Hayır
type

Ücret planı türü. Geçerli değerler şunları içerir:

  • REVSHARE - Gelir paylaşımı modeli.
  • RATECARD - Ücret listesi modeli.
  • REVSHARE_RATECARD - Gelir paylaşımı ve ücret listesi modeli.
  • USAGE_TARGET - Ayarlanabilir bildirim modeli.

Ücret planı türleri hakkında daha fazla bilgi için Desteklenen ücret planı türleri başlıklı makaleye bakın.

 Yok Evet