API ürün paketlerini yönetme

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

Bir veya daha fazla API ürününü, aşağıdaki bölümlerde açıklandığı şekilde, API ürün paketi olarak adlandırılan, para kazanılan tek bir kapsayıcıda gruplandırma.

API ürün paketi nedir?

API ürün paketi, geliştiricilere grup olarak sunulan ve genellikle para kazanma için bir veya daha fazla ücret planıyla ilişkilendirilen API ürünlerinden oluşan bir koleksiyondur. Birden fazla API ürün paketi oluşturabilir ve bunların her birine bir veya daha fazla API ürünü ekleyebilirsiniz. Aynı API ürününü veya ürünleri farklı paketlere yerleştirebilir ve farklı (veya aynı) ücret planlarıyla ilişkilendirebilirsiniz.

Geliştiriciler, yalnızca şu anda yürürlükte olan ücret planlarından birini satın alarak uygulamalarını API ürün paketi kullanacak şekilde kaydedebilir. API ürün paketi, siz ürün paketi için bir ücret planı ekleyip yayınlayana (herkese açık olarak) kadar geliştiriciler tarafından görülemez (Ücret planlarını yönetme bölümünde açıklandığı gibi) (geçerli tarihin veya gelecekteki bir tarihin başlangıç tarihiyle birlikte) seçin. Ücret planı ekleyip yayınladıktan sonra, geliştirici portalınıza giriş yapan geliştiriciler API ürün paketini seçebilir ücret planını seçin. Alternatif olarak, Management API'yi kullanarak geliştirici için ücret planını kabul edebilirsiniz. Daha fazla bilgi için API kullanarak yayınlanan ücret planlarını satın alma bölümüne bakın.

Bir API ürün paketine API ürünü ekledikten sonra API ürünü. Bunu yalnızca aşağıdakilerin tümü geçerliyse yapmanız gerekir:

• API ürünü için bir gelir paylaşımı oranı planı ayarlarsınız.
• Geliştiriciler, API ürünündeki kaynakların kullanımı için üçüncü taraflardan ücret alır.
• Geliştiricilerin ödeyebileceği tutarla ilgili bir minimum veya maksimum kısıtlama bulunmaktadır ve geliştiricilerine kısıtlama hakkında bilgi verin.

Minimum ve maksimum fiyatlar, API ürün paketinin ayrıntılarında gösterilir.

Ürün Paketleri sayfasını keşfetme

Aşağıda açıklandığı şekilde Ürün Paketleri sayfasına erişin.

Ürün paketi ekleme

API ürün paketi eklemek için:

1. Ürün Paketleri sayfasında + API Ürün Paketi'ni tıklayın.
2. API ürün paketi için bir ad girin.

3. Ürün Ekle alanına bir API ürününün adını girin.

   Siz bir API ürününün adını yazarken, dizeyi içeren API ürünlerinin listesi bir açılır listede görüntülenir. Pakete eklemek istediğiniz API ürününün adını tıklayın. Başka API ürünleri eklemek için bu işlemi tekrarlayın.

4. Başka API ürün adları eklemek için 3. adımı tekrarlayın.
5. Eklediğiniz her API ürünü için işlem kaydetme politikasını yapılandırın.
6. Ürün Paketini Kaydet'i tıklayın.

Ürün paketini düzenleme

Bir ürün paketini düzenlemek için:

1. Ürün Paketleri sayfasında, düzenlemek istediğiniz ürün paketinin satırını tıklayın.

   Ürün paketi paneli gösterilir.

2. Ürün paketi alanlarını gerektiği gibi düzenleyin.

   Daha fazla bilgi için işlem kaydetme politikasını yapılandırma bölümüne bakın.

3. Ürün Paketini Güncelle'yi tıklayın.

API'yi kullanarak API ürün paketlerini yönetme

Aşağıdaki bölümlerde, API kullanılarak API ürün paketlerinin nasıl yönetileceği açıklanmaktadır.

API'yi kullanarak API ürün paketi oluşturma

API ürün paketi oluşturmak için şu adrese bir POST isteği gönderin: /organizations/{org_name}/monetization-packages Bu isteği gönderirken zorunluluk:

• API ürün paketine dahil edilecek API ürünlerini tanımlayın.
• API ürün paketi için bir ad ve açıklama belirtin.
• API ürün paketi için bir durum göstergesi ayarlayın. Durum göstergesinde şu değerler: CREATED, ACTIVE, INACTIVE. Şu anda, belirttiğiniz durum göstergesi değeri API ürün paketinde tutulur ancak herhangi bir amaçla kullanılmaz.

İsteğe bağlı olarak, kuruluşu belirtebilirsiniz.

Gösterilen seçeneklerin listesi için API ürün paketi yapılandırma özelliklerine bakın. API.

Örneğin:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "description": "payment messaging package",
     "displayName": "Payment Messaging Package",
     "name": "Payment Messaging Package",
     "organization": { "id": "{org_name}" },
     "product": [
       { "id": "messaging" },
       { "id": "payment" }
     ],
     "status": "CREATED"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password

Aşağıda yanıtın bir örneği verilmiştir:

{
   "description" : "payment messaging package",
   "displayName" : "Payment Messaging Package",
   "id" : "payment_messaging_package",
   "name" : "Payment Messaging Package",
   "organization" : {
     "id" : "{org_name}",
     "separateInvoiceForFees" : false
   },
   "product" : [ {
     "customAtt1Name" : "user",
     "description" : "Messaging",
     "displayName" : "Messaging",
     "id" : "messaging",
     "name" : "messaging",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }, {
     "customAtt1Name" : "user",
     "description" : "Payment",
     "displayName" : "Payment",
     "id" : "payment",
     "name" : "payment",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }],
   "status" : "CREATED"
 }

Yanıtın, API ürünleri hakkında ek bilgiler ve tüm özel söz konusu API ürünleri için belirtilen özellikler. (Özel özellikler, API ürünü.) Bir API ürününün özel özellikleri, çeşitli ücret planlarında hesaba katılabilir. Örneğin, Örneğin, her işlem için geliştiriciden ödeme aldığınız bir ücret listesi planı oluşturursanız planın ücretini, aktarılan bayt sayısı gibi özel bir özelliğe göre ayarlayabilir unutmayın.

API'yi kullanarak API ürün paketindeki API ürünlerini yönetme

API'yi kullanarak API ürün paketine bir API ürünü ekleyebilir veya ürün paketinden bir API ürününü silebilirsiniz: bu bölümde bulabilirsiniz.

API ürün paketine API ürünü ekleme

Bir API ürün paketine API ürünü eklemek için şuraya bir POST isteği gönderin: organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, burada {org_name} kuruluşunuzun adını belirtir, {package_id} API ürün paketi adını belirtir ve {product_id}, API'nin kimliğini belirtir belirler.

Örneğin:

$ curl -H "Accept:application/json" -X POST -d \
'{}'\
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API ile bir API ürün paketine API ürünü ekleme ürüne özel ücret planları

Bir veya daha fazla API ürününe özel ücret planı olan API ürün paketine API ürünü eklemek için tanımlanan (ücret listesi veya gelir paylaşımı), organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, burada {org_name} kuruluşunuzun adını belirtir, {package_id} API ürün paketi adını belirtir ve {product_id}, API'nin kimliğini belirtir belirler.

İstek gövdesinde yeni API ürününün ücret planı ayrıntılarını iletmeniz gerekir. Araç Çubuğu’nun ratePlanRates dizisinde, ücret planı değerlerinin tüm diğer API ürünlerine özgüdür. Tanımlanabilen ücret planı özellikleri hakkında daha fazla bilgi için Yapılandırma özellikleri inceleyin.

Örneğin:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [ 
        {
            "id": "mypackage_rateplan1",
            "ratePlanDetails": [
                {
                    "currency": {
                        "id": "usd"
                    },
                    "duration": 1,
                    "durationType": "MONTH",
                    "meteringType": "UNIT",
                    "organization" : {
                        "id": "{org_name}",
                    "paymentDueDays": "30",
                    "ratePlanRates": [
                        {
                            "rate": "1.99",
                            "startUnit": "0",
                            "type": "RATECARD"
                        }
                    ],
                    "ratingParameter": "VOLUME",
                    "type": "RATECARD"
                }
            ]
        }
    ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

Bir API ürün paketinden API ürününü silme

Bir API ürün paketindeki API ürününü silmek için organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, burada {org_name} kuruluşunuzun adını belirtir, {package_id} API ürün paketi adını belirtir ve {product_id}, API'nin kimliğini belirtir belirler.

Örneğin:

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

API'yi kullanarak API ürün paketlerini görüntüleme

Bir kuruluştaki belirli bir API ürün paketini veya tüm API ürün paketlerini alabilirsiniz. Ayrıca transkriptinizi Belirli bir tarih aralığında işlemleri olan, yani yalnızca şuna ait paketleri içeren API ürün paketlerini alın: Kullanıcıların belirli bir başlangıç ve bitiş noktalarında bu paketlerdeki API'lere erişen uygulamaları çağırdığı tarihi.

Belirli bir API ürün paketini görüntüleme: Belirli bir API ürün paketini almak için GET isteği yayınlayın Hedef: /organizations/{org_name}/monetization-packages/{package_id}, burada: {package_id}, API ürün paketinin kimliğidir (kimlik yanıtı ekleyin). Örneğin:

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

Tüm API ürün paketlerini görüntüleme: Bir kuruluşun tüm API ürün paketlerini almak için GET isteği gönderin /organizations/{org_name}/monetization-packages için istek. Örneğin:

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

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

Bir kuruluştaki tüm API ürün paketlerini görüntüleme yanıtı aşağıdaki gibi görünmelidir (yalnızca bölüm gösterilir):

{
  "monetizationPackage" : [ {
    "description" : "payment messaging package",
    "displayName" : "Payment Messaging Package",
    "id" : "payment_messaging_package",
    "name" : "Payment Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "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"
  }, {
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "Payment",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  } ],
  "totalRecords" : 3
}

İşlemlerle birlikte API ürün paketlerini görüntüleme: Bir bir GET isteği gönderin ve /organizations/{org_name}/packages-with-transactions. Talebinizi iletirken sorgu parametreleri olarak tarih aralığı için bir başlangıç tarihi ve bitiş tarihi belirtmeniz gerekir. Örneğin, Örneğin, aşağıdaki istek ayındaki işlemlere sahip API ürün paketlerini alır Ağustos 2013.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \
-u email:password

Yanıt aşağıdaki gibi görünecektir (yanıtın yalnızca bir kısmı gösterilir):

{
  "monetizationPackage" : [ {
    "description" : "Payment Package",
    "displayName" : "Payment Package",
    "id" : "payment_package",
    "name" : "Payment Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "payment api product",
      "displayName" : "payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  }, {
    "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"
  },
     ...
  } ]
}

API'yi kullanan geliştirici veya şirket tarafından kabul edilen API ürün paketlerini görüntüleme

GET düzenleyerek belirli bir geliştirici veya şirket tarafından kabul edilen API ürün paketlerini görüntüleme aşağıdaki API'lere istek gönderebilirsiniz:

• /organizations/{org_name}/developers/{developer_id}/monetization-packages, burada: {developer_id}, geliştiricinin kimliğidir (e-posta adresi).
• /organizations/{org_name}/companies/{company_id}/monetization-packages, burada: {company_id} şirketin kimliğidir.

İsteği gönderirken isteğe bağlı olarak aşağıdaki sorgu parametrelerini belirtebilirsiniz:

Örneğin, aşağıdaki istek belirli bir web sitesi tarafından kabul edilen tüm API ürün paketlerini geliştirici:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \
-u email:password

Aşağıdaki istek yalnızca belirli bir şirket tarafından kabul edilen etkin API paketlerini getirir:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \
-u email:password

API kullanarak API ürün paketini silme

Bir API ürün paketini yalnızca tanımlanmış ücret planı yoksa silebilirsiniz.

Tanımlanmış ücret planı olmayan bir API ürün paketini silmek için DELETE isteği gönderin alıcı: organizations/{org_name}/monetization-packages/{package_id}, burada {org_name} kuruluşunuzun adını belirtir ve {package_id}, API ürün paketi adını belirtir.

Örneğin:

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

API için API ürün paketi yapılandırma özellikleri

Aşağıdaki API ürün paketi yapılandırma seçenekleri API'den yararlanabilir: