API'yi kullanarak satın alma oranı planları

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

Bu bölümde, yayınlanmış bir ücret planının nasıl satın alınacağı ve satın alınan bir öğenin süresinin nasıl dolacağı veya iptal edileceği açıklanmaktadır ücret planı oluşturabilirsiniz.

API'yi kullanarak yayınlanmış bir ücret planı satın alma

Bir ücret planı yayınlandıktan sonra, bir geliştirici veya şirket bunu tarihine kadar satın alabilir (veya "kabul edebilir"). bir POST isteği gönderen /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans, Burada {org_name} kuruluşun adı ve {developer_or_company_id}, geliştiricinin veya şirketin kimliğidir.

Ücret planı satın alırken kurulum ücretlerinden feragat etmek için waivefees sorgu parametresini ayarlayın Hedef: true. Bu işaret, geliştiricileri para kazanma özelliğine taşırken kullanışlıdır. Geliştiricileri para kazanma.

Aşağıdaki tabloda, istek gövdesi, varsayılan değerleri ve gerekli olup olmadıkları gibi bilgiler yer alır.

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

Ücret planının başladığı tarih. Örneğin: 2017-03-24.

Yok Evet
endDate

Ücret planının sona erdiği tarih. Örneğin: 2017-09-24.

Ücret planı, şu tarihte günün sonuna kadar geçerli olacaktır: belirtilen tarih. Örneğin, 1 Aralık 2017'de bir ücret planının süresini sona erdirmek istiyorsanız: endDate değerini, 30.11.2017'ye kadar. Burada Ücret planının geçerlilik süresi, 30 Kasım 2017'de gün sonunda sona erer; tüm istekler .

Yok Hayır
developer

id mülkündeki geliştirici veya şirketin kimliğini ücret planını satın alıyor.

Yok Evet
quotaTarget

Uygulama geliştirici için izin verilen hedef işlem sayısı. Aşağıdaki durumlarda ve hedef sayının yüzde kaçına göre bildirim gönderileceği (%90, %100 veya %150 gibi). Ek işlemler hedef sayıya ulaşıldı.

Bir uygulamanın bildirimlerini devre dışı bırakmak için bu değeri pozitif bir tam sayı değerine veya 0 olarak ayarlayın. geliştiriciyim.

0 Hayır
ratePlan

Ücret planının kimliğini tanımlayan id özelliği.

Ücret planı kimliği, görünen addan farklıdır. Ücret planı ayrıntılarını görüntülemek için: kimliği de dahil olmak üzere bkz. Ücret planları sayfasını keşfetme.

Yok Evet
suppressWarning

Geliştirici satın alma işlemi yapmaya çalıştığında hatanın engellenip gizlenmeyeceğini belirten işaret Başka bir satın alınan ücret planıyla çakışan bir ücret planı. Değer şunlardan biri olabilir: takip etmek için:

  • true - Para kazanma özelliği, geliştiricinin, çakışan API ürünleri içeren API paketleri kullanması gerekir. O zaman Geliştirici için yeni bir API paketi satın alır.
  • false - Çakışma olması durumunda hata bildirilir ücret planı.
Yok Hayır
waveTerminationCharge

Etkin bir ücret planı şu durumlarda fesih ücretlerinden feragat edilip edilmeyeceğini belirten işaret yeni ücret planının etkinleştirilmesi kapsamında sonlandırıldı. Değer şunlardan biri olabilir: takip etmek için:

  • true - Etkin bir ücret planı feshedildiğinde fesih ücretinden feragat etme .
  • false - Etkin ücret planı şu olduğunda fesih ücretinden feragat etmeyin: yeni ücret planını etkinleştirme kapsamında feshedildi.
Yok Hayır

Örneğin, aşağıdaki istek location_&_messaging ücret planını satın alıyor belirtilen geliştirici için:

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

Bu örnekte, suppressWarning özelliği false olarak ayarlanmıştır. İçinde Bu durumda, çakışma olması durumunda bir hata verilir. Örneğin, geliştirici satın alınan başka bir ücret planıyla çakışan bir ücret planı satın almaya çalıştığında hata bildirilir. Bu hataya müdahale etmek üzere para kazanmak için kullanıcı arayüzü sağlayan bir uygulamayı etkinleştirir. çakışan ürünleri onay için geliştiriciye gösterme (uygun durumlarda). Eğer suppressWarning true olarak ayarlandı ve para kazanma özelliği, satın alınan tüm öğeleri fesheder Geliştiricinin çakışan ürünleri içeren API paketleri için yapması gereken ücret planlarını. O zaman Geliştirici için yeni bir API paketi satın alır.

Aşağıdaki istek, düzenlenebilir bir bildirim oranı planı satın alır ve hedef sayıyı belirler 4.000'e çıktı.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

Yukarıdaki örneklerin her birinde aşağıdaki hata mesajı döndürülürse:

Developer legal name not specified. 

Ardından para kazanma özelliklerini MINT_DEVELOPER_ADDRESS ve MINT_DEVELOPER_LEGAL_NAME, ardından API çağrısını tekrarlayın.

Bir geliştirici tarafından API kullanılarak satın alınan bir ücret planının süresinin dolması

Bir geliştirici tarafından satın alınan ücret planının süresini sona erdirmek (veya iptal etmek) için satın aldığınız ücret planı ayrıntılarını görüntüleyin ve endDate özelliğini, PUT isteği ile /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id} kaynağı.

Ücret planı, günün sonunda günün sonuna kadar geçerli olur. belirtilen tarih. Örneğin, bir ücret planının süresini 1 Aralık 2017'de sona erdirmek istiyorsanız endDate değerini ayarlayın 30.11.2017'ye kadar. Bu durumda, Ücret planının süresi 30 Kasım 2017'de gün sonunda sona erecektir; 1 Aralık'taki tüm taleplerin 2017 engellenecek.

Satın alma işlemini gerçekleştirdiğinizde {developer_rateplan_id}, yanıtta iade edilir ücret planını kontrol eder.

Örneğin:

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Alternatif olarak, {developer-rateplan-id} GET isteği göndererek geliştirici ücret planı alıcı: /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, Burada {developer_id}, geliştiricinin e-posta adresidir. Daha fazla daha fazla bilgi için Görüntüleme Geliştirici tarafından satın alınan tüm ücret planları.

Aşağıdaki istekte bitiş tarihi 1 Aralık 2017 olarak güncellenir. Yani ücret planı 30 Kasım 2017 gün sonunda geçerliliğini yitirecek; 1 Aralık 2017 tarihindeki tüm talepler engellendi.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'