Gelir paylaşımı planını yapılandırın

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

Giriş

Gelir paylaşımı planında API sağlayıcısı, her işlemden elde edilen gelirin belirli bir yüzdesini (işlemin brüt veya net fiyatına göre) geliştiriciyle paylaşır. Gelir paylaşımı planı oluştururken, sabit veya esnek bir paylaşım modeli ve fiyatlandırmaya dayalı (ör. gelir paylaşımının bir işlemin brüt veya net fiyatına göre belirlenmesi) belirtmeniz gerekir. İşlem kaydetme politikasını oluştururken işlemin brüt veya net fiyatını belirlersiniz.

Sabit paylaşım modelinde, her işlemden elde edilen gelirin sabit bir yüzdesini (işlemin brüt veya net fiyatına göre) geliştiriciyle paylaşırsınız. Esnek paylaşım modelinde, gelirin değişken bir yüzdesini geliştiriciyle paylaşırsınız. Gelir paylaşımı, belirli bir dönemde elde edilen gelire bağlıdır. Gelir paylaşımı hesaplamasında kullanılan yüzde, işlemler tarafından oluşturulan gelir tutarına göre değişiklik gösterebilir.

Kullanıcı arayüzünü kullanarak gelir paylaşımı planı ayrıntılarını belirtme

Gelir paylaşımı planlarını aşağıda açıklandığı şekilde yapılandırın.

API'yi kullanarak gelir paylaşımı planı ayrıntılarını belirtme

Gelir paylaşımı planının ayrıntılarını ücret planını oluştururken belirtirsiniz. Ayrıntıları, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans çağrısının istek gövdesinde yer alan ratePlanDetails özelliğinde belirtirsiniz. ratePlanDetails özelliğinde neleri belirteceğiniz, seçtiğiniz paylaşım modeline bağlıdır: sabit veya esnek.

Sabit paylaşım modeli için gelir paylaşımı planı ayrıntılarını belirtme

Sabit paylaşım modelini uygulamak için ücret planı ayrıntılarında aşağıdakileri belirtirsiniz:

• Ücret planının işlemlere dayalı olduğunu belirten bir puan parametresi (VOLUME). Varsayılan değer VOLUME'dir.
• Gelir paylaşımının birim başına sabit olduğunu belirten bir sayaç türü (UNIT).
• Gelir türü (GROSS veya NET). Gelir paylaşımının bir işlemin brüt veya net fiyatına dayalı olduğunu gösterir.
• Son ödeme dönemi (örneğin, 30 gün).
• Kuruluşunuzun kimliği.
• Şirketinizin kullandığı "temel" veya muhasebe para birimidir.
• Gelir paylaşımının nasıl hesaplandığı hakkında ayrıntılar sağlayan bir ücret planı ücreti. Paylaşım modeli sabit bir ücreti temel aldığından, yalnızca bir ücret planı ücreti belirtirsiniz.

Ücret planı ayrıntı özelliklerinin tam listesi için Ücret planı ayrıntıları için yapılandırma özellikleri bölümüne bakın.

Ücret planı ücretinde aşağıdakileri belirtirsiniz:

• Ücret planı ücretinin türü (REVSHARE).
• Gelir paylaşımının hesaplanmasında kullanılan yüzde. Örneğin, 80,5555 değerini belirtirseniz gelir paylaşımı %80,5555 olur. Bir başka deyişle, API sağlayıcısı olarak geliştiriciye her işlem için alınan fiyatın% 80,5555'ini ödersiniz (veya bir işlemdeki bayt sayısı gibi özel bir özelliğe dayanarak geliştiriciye, alınan fiyatın% 80,5555'i iletilmesi için ödeme yaparsınız).
• Ücret uygulamasının başlangıç birimi (0). Bu, fiyatın ilk işlemden başlayarak her işleme uygulandığı anlamına gelir.

Ücret planı özelliklerinin tam listesi için Ücret planları için yapılandırma özellikleri bölümüne bakın.

Örneğin, aşağıda sabit paylaşım modeliyle bir gelir paylaşımı planı oluşturulur. Gelir paylaşımı yüzdesi %80,5555'tir. Gelir paylaşımı, işlemin net fiyatını temel alır. Sözleşme 15 Eylül 2013'te yürürlüğe girecektir ve ödeme 30 gün içinde yapılacaktır. (Gelir paylaşımıyla ilgili ayrıntılar vurgulanmıştır.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "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" \
-u email:password

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

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

Esnek paylaşım modeli için gelir paylaşımı planı ayrıntılarını belirtme

Esnek paylaşım modelinde, bir veya daha fazla ücret planı ücreti içeren ücret planı ayrıntılarını belirtirsiniz. Her ücret planı ücreti, bir işlem geliri aralığını kapsar (her aralığa "gelir grubu" denir). Her gelir grubu için bir gelir paylaşımı yüzdesi belirlersiniz.

Ücret planı ücretlerine ek olarak, ücret planı ayrıntılarında aşağıdakileri belirtirsiniz:

• Ücret planının işlemlere dayalı olduğunu belirten bir puan parametresi (VOLUME). Varsayılan değer VOLUME'dir.
• Gelir paylaşımının işlem hacmine dayalı olmadığını (yani sabit paylaşım modelinde olduğu gibi) sabit olmadığını gösteren bir sayaç türü (VOLUME).
• Gelir türü (GROSS veya NET). Gelir paylaşımının bir işlemin brüt veya net fiyatına dayalı olduğunu gösterir.
• Son ödeme dönemi (örneğin, 30 gün).
• Kuruluşunuzun kimliği.
• Şirketinizin kullandığı "temel" veya muhasebe para birimidir.
• Gelirin toplandığı süreyi birlikte belirten bir süre ve süre türü (buna "toplama temeli" de denir). İşlemler, toplam gelirin ve geçerli gelir aralığının hesaplanması için toplama temelinde toplanır (örneğin, 1 ay). Her işleme uygulanan gelir paylaşımı yüzdesi, gelir aralığına bağlıdır.
• Geçerli gelir aralığını belirlemek için kullanılan toplama sayaçları.

Ücret planı ayrıntı özelliklerinin tam listesi için Ücret planı ayrıntıları için yapılandırma özellikleri bölümüne bakın.

Her bir ücret planı ücreti için aşağıdakileri belirtirsiniz:

• Gelir aralığı (REVSHARE) için ücret planı ücreti türü.
• Gelir bandının gelir paylaşımını hesaplamak için kullanılan yüzde. Örneğin, 80, 5555 değerini belirtirseniz gelir bandının gelir paylaşımı %80,5555 olur. Bir başka deyişle, API sağlayıcısı olarak geliştiriciye bu gelir aralığında her işlem için alınan fiyatın% 80, 5555'ini ödersiniz.
• Gelir grubunun başlangıç ve bitiş birimi. Başlangıç birimi, gelir bandının alt sınırını, bitiş birimi ise gelir grubunun üst sınırını belirtir. Örneğin, başlangıç birimi için 0 ve bitiş birimi için 1.000 değerini belirtirseniz gelir grubu, belirtilen para biriminde 0'dan yüksek ve 1.000'e kadar olan işlem gelirini kapsar. Para birimi ABD doları ise toplama temeli 1 ay ve gelir aralığının yüzdesi %80,5555 ise bir ayda gelir olarak 1.000 ABD dolarına varan işlemler için gelir paylaşımı işlem fiyatının% 80,5555'i olur.

  Nihai gelir grubu için bir bitiş birimi belirtmezseniz bu grubun paylaşım yüzdesi, toplam gelir bu grup için başlangıç biriminin üzerine çıktıktan sonra tüm işlemlere uygulanır. Örneğin, son grubun başlangıç birimi 1.000 ise (ABD doları olduğunu varsayın) ve bu grup için bitiş birimi belirtmezseniz grubun gelir yüzdesi, toplam dönem boyunca geliri 1. 000 ABD dolarının üzerindeki tüm işlemlere uygulanır.

Ücret planı özelliklerinin tam listesi için Ücret planları için yapılandırma özellikleri bölümüne bakın.

Örneğin, aşağıda belirtilen yöntem esnek paylaşım modeliyle bir gelir paylaşımı planı oluşturur. İki gelir bandı belirtir. İlk grup, 1.000 ABD dolarına kadar olan işlem gelirlerini kapsar. İkinci grup, 1.000 ABD dolarının üzerindeki işlem gelirlerini kapsar. Gelir paylaşımı yüzdesi, birinci gelir grubu için% 80,5555 ve ikinci gelir grubu için% 90,5'tir. Gelir paylaşımı, işlemin net fiyatını temel alır. Toplama 1 aydır. Sözleşme dönemi 15 Eylül 2013'te yürürlüğe girecek ve ödeme 30 gün içinde yapılacaktır. (Gelir paylaşımıyla ilgili ayrıntılar vurgulanmıştır.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "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" \
-u email:password

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

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
       …
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}