Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Bu bölümde, yayınlanmış bir ücret planının nasıl satın alınacağı ve istenirse API kullanılarak satın alınan bir ücret planının nasıl süresinin dolacağı veya iptal edileceği açıklanmaktadır.
API'yi kullanarak yayınlanmış bir ücret planını satın alma
Bir ücret planı yayınlandıktan sonra, geliştirici veya şirket /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans için POST isteği göndererek planı satın alabilir (ya da "kabul edebilir"). Burada {org_name}, kuruluşun adı, {developer_or_company_id} ise geliştiricinin veya şirketin kimliğidir.
Ücret planı satın alırken kurulum ücretlerinden feragat etmek için waivefees sorgu parametresini true olarak ayarlayın. Bu işaret, Geliştiricileri para kazanmaya taşıma bölümünde açıklandığı gibi geliştiricileri para kazanma yöntemine taşırken kullanışlıdır.
Aşağıdaki tabloda, istek gövdesinde belirtebileceğiniz yapılandırma özellikleri, bunların varsayılan değerleri ve gerekli olup olmadıkları özetlenmiştir.
| 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ı, belirtilen tarihte günün sonuna kadar geçerli olur. Örneğin, bir ücret planının süresinin 1 Aralık 2017'de sona ermesini istiyorsanız endDate değerini 2017-11-30 olarak ayarlamanız gerekir. Bu durumda, ücret planının süresi 30 Kasım 2017'de sona erer ve 1 Aralık 2017'deki tüm istekler engellenir. |
Yok | Hayır |
developer |
Ücret planını satın alan geliştiricinin veya şirketin kimliğini tanımlayan |
Yok | Evet |
quotaTarget |
Uygulama geliştirici için izin verilen işlem sayısı hedef. Bildirimlerin gönderilip gönderilmeyeceğini ve ne zaman gönderileceğini, hedef sayının yüzdesine (ör. %90, %100 veya %150) göre yapılandırabilirsiniz. Hedef sayıya ulaşıldığında ek işlemler engellenmez. Bir uygulama geliştiricisi için bildirimleri devre dışı bırakmak için bu değeri pozitif bir tam sayı değerine veya 0'a ayarlayın. |
0 |
Hayır |
ratePlan |
Ücret planının kimliğini tanımlayan Ücret planı kimliği, görünen addan farklı. Kimlik de dahil olmak üzere ücret planı ayrıntılarını görüntülemek için Ücret planlarını keşfetme sayfasına bakın. |
Yok | Evet |
suppressWarning |
Geliştirici, satın alınan başka bir ücret planıyla çakışan bir ücret planı satın almaya çalıştığında hatanın engellenip engellenmeyeceğini belirten işaret. Değer şunlardan biri olabilir:
|
Yok | Hayır |
waveTerminationCharge |
Yeni ücret planının etkinleştirilmesi kapsamında etkin bir ücret planı feshedildiğinde fesih ücretlerinden feragat edilip edilmeyeceğini belirten işaret. Değer şunlardan biri olabilir:
|
Yok | Hayır |
Örneğin, aşağıdaki istek, belirtilen geliştirici için location_&_messaging ücret planını satın alır:
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. Bu durumda, çakışma durumunda 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ışırsa hata verilir. Bu işlem, para kazanma için kullanıcı arayüzü sağlayan bir uygulamanın hataya müdahale etmesine ve çakışan ürünleri onay için (uygun olduğu şekilde) geliştiriciye göstermesine olanak tanır. suppressWarning, true olarak ayarlanırsa para kazanma, geliştiricinin çakışan ürünleri içeren API paketleri için sahip olduğu tüm satın alınan ücret planlarını sonlandırır. Daha sonra geliştirici için yeni bir API paketi satın alır.
Aşağıdaki istek, ayarlanabilir bir bildirim oranı planı satın alır ve işlem sayısını 4.000 olarak ayarlar.
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 herhangi birinde aşağıdaki hata mesajı döndürülürse:
Developer legal name not specified.
Ardından MINT_DEVELOPER_ADDRESS ve MINT_DEVELOPER_LEGAL_NAME para kazanma özelliklerini ayarlayıp API çağrısını tekrarlamanız gerekir.
API kullanarak geliştirici tarafından satın alınan ücret planının süresinin dolması
Geliştirici tarafından satın alınan bir ücret planının süresini sona erdirmek (veya iptal etmek) için satın alınan ücret planı ayrıntılarını güncelleyin ve bir PUT isteğindeki istek gövdesinde endDate özelliğini /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id} kaynağına belirtin.
Ücret planı, belirtilen bitiş tarihinde günün sonuna kadar geçerli olur. Örneğin, bir ücret planının süresinin 1 Aralık 2017'de sona ermesini istiyorsanız endDate değerini 2017-11-30 olarak ayarlamanız gerekir. Bu durumda, ücret planının süresi 30 Kasım 2017'de sona erer ve 1 Aralık 2017'deki tüm istekler engellenir.
{developer_rateplan_id}, yayınlanan ücret planını satın aldığınızda yanıta döndürülür.
Ö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, /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans adresine GET isteği göndererek geliştirici ücret planı için {developer-rateplan-id} edinebilirsiniz. Buradaki {developer_id}, geliştiricinin e-posta adresidir. Daha fazla bilgi için Geliştirici tarafından satın alınan tüm ücret planlarını görüntüleme bölümünü inceleyin.
Aşağıdaki istek, bitiş tarihini 1 Aralık 2017 olarak günceller. Yani ücret planının süresi 30 Kasım 2017'de sona erecektir ve 1 Aralık 2017'de yapılan tüm istekler engellenir.
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
}'