수익 공유 계획 구성

Apigee Edge 문서입니다.
Apigee X 문서로 이동 정보

소개

수익 공유 계획에서 API 제공업체는 각 거래에서 발생한 수익의 비율 (거래의 총 가격 또는 순 가격 기준)을 개발자와 공유합니다. 수익 공유 계획을 만들 때는 고정 또는 유연할 수 있는 공유 모델과 가격 책정 기준 (예: 수익 공유가 거래의 총가격 또는 순가격을 기준으로 하는지 여부)을 표시해야 합니다. 거래 기록 정책을 만들 때 거래의 총액 또는 순가를 설정합니다.

고정 공유 모델에서는 거래의 총 가격 또는 순 가격을 기반으로 각 거래에서 발생한 수익의 고정 비율을 개발자와 공유합니다. 유연한 공유 모델에서는 개발자와 수익의 가변 비율을 공유합니다. 수익 배분율은 일정 기간 동안 발생한 수익에 따라 달라집니다. 수익 공유 계산에 사용되는 비율은 거래에서 발생한 수익 금액에 따라 달라질 수 있습니다.

UI를 사용하여 수익 공유 계획 세부정보 지정

아래 설명에 따라 수익 공유 계획을 구성합니다.

API를 사용하여 수익 배분 계획 세부정보 지정

요금제를 만들 때 수익 공유 요금제 세부정보를 지정합니다. /organizations/{org_name}/monetization-packages/{package_id}/rate-plans 호출에서 요청 본문 내 ratePlanDetails 속성에 세부정보를 지정합니다. ratePlanDetails 속성에 지정하는 내용은 고정 또는 유연 중에서 선택한 공유 모델에 따라 다릅니다.

고정 공유 모델의 수익 배분 요금제 세부정보 지정

고정 공유 모델을 구현하려면 요금제 세부정보에서 다음을 지정합니다.

• 요금제가 거래를 기반으로 함을 나타내는 평가 매개변수(VOLUME). 기본값은 VOLUME입니다.
• 수익 공유가 단위당 고정되어 있음을 나타내는 측정 유형(UNIT)입니다. 즉, 유연한 공유 모델의 경우와 같이 거래량을 기준으로 하지 않습니다.
• 수익 유형 (GROSS 또는 NET). 수익 배분이 거래의 총 가격을 기준으로 하는지 순 가격을 기준으로 하는지 나타냅니다.
• 결제 기한입니다 (예: 30일).
• 조직의 ID입니다.
• 회사에서 사용하는 '기본' 또는 회계 통화입니다.
• 수익 공유 계산 방식에 대한 세부정보를 제공하는 요금제 요율. 공유 모델은 고정 요율을 기반으로 하므로 요금제 요율을 하나만 지정합니다.

요금제 세부정보 속성의 전체 목록은 요금제 세부정보 구성 속성을 참고하세요.

요금제 요금에서 다음을 지정합니다.

• 요금제 요금의 유형 (REVSHARE)입니다.
• 수익 배분을 계산하는 데 사용되는 비율입니다. 예를 들어 80.5555를 지정하면 수익 공유 비율은 80.5555%가 됩니다. 즉, API 제공업체는 개발자에게 각 거래에 대해 청구된 가격의 80.5555% 를 지급합니다. 또는 거래에서 전송된 바이트 수와 같은 맞춤 속성을 기반으로 하는 경우 개발자에게 지정된 바이트 수를 전송하는 데 청구된 가격의 80.5555% 를 지급합니다.
• 요금 적용의 시작 단위 (0)입니다. 즉, 요금은 첫 번째 거래부터 각 거래에 적용됩니다.

요금제 속성의 전체 목록은 요금제 구성 속성을 참고하세요.

예를 들어 다음은 고정된 공유 모델이 있는 수익 공유 계획을 만듭니다. 수익 공유 비율은 80.5555%입니다. 수익 공유는 거래의 순 가격을 기준으로 합니다. 계약은 2013년 9월 15일부터 유효하며 지불 기한은 30일입니다. 수익 공유 관련 세부정보가 강조 표시되어 있습니다.

$ 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

응답은 다음과 같아야 합니다 (응답의 일부만 표시됨).

{
  "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"
}

유연한 공유 모델의 수익 배분 요금제 세부정보 지정

유연한 공유 모델에서는 하나 이상의 요금제 요금을 포함하는 요금제 세부정보를 지정합니다. 각 요금제 요율은 거래 수익의 범위를 적용합니다 (각 범위를 '수익 범위'라고 함). 수익 범위별로 수익 공유 비율을 할당합니다.

요금제 세부정보에 요금제 세부정보에 다음을 지정합니다.

• 요금제가 거래를 기반으로 함을 나타내는 평가 매개변수(VOLUME). 기본값은 VOLUME입니다.
• 수익 배분이 거래량을 기준으로 하지 않음을 나타내는 측정 유형 (VOLUME)입니다 (즉, 고정 공유 모델의 경우처럼 고정이 아님).
• 수익 유형 (GROSS 또는 NET). 수익 배분이 거래의 총 가격을 기준으로 하는지 순 가격을 기준으로 하는지 나타냅니다.
• 결제 기한입니다 (예: 30일).
• 조직의 ID입니다.
• 회사에서 사용하는 '기본' 또는 회계 통화입니다.
• 수익이 집계되는 기간을 함께 지정하는 기간 및 기간 유형입니다('집계 기준'이라고도 함). 거래는 집계 기준 (예: 1개월)에 걸쳐 집계되어 총 수익과 해당 수익 범위를 계산합니다. 각 거래에 적용되는 수익 공유 비율은 수익 대역에 따라 다릅니다.
• 해당하는 수익 범위를 결정하는 데 사용되는 집계 카운터입니다.

요금제 세부정보 속성의 전체 목록은 요금제 세부정보 구성 속성을 참고하세요.

요금제 요금마다 다음을 지정합니다.

• 수익 범위의 요금제 요금 유형 (REVSHARE)입니다.
• 수익 범위의 수익 공유를 계산하는 데 사용되는 비율입니다. 예를 들어 80.5555를 지정하면 수익 단위의 수익 배분율은 80.5555%입니다. 즉, API 제공업체는 해당 수익 단위의 각 거래에 청구된 가격의 80.5555% 를 개발자에게 지불합니다.
• 수익 범위의 시작 및 종료 단위입니다. 시작 단위는 수익 범위의 하한을 지정하고 종료 단위는 수익 범위의 상한을 지정합니다. 예를 들어 시작 단위를 0으로, 종료 단위를 1,000으로 지정하면 수익 범위는 거래 수익이 0보다 크고 1,000까지 지정된 통화로 포함됩니다. 통화가 미국 달러이고 집계 기준이 1개월이고 수익 범위의 비율이 80.5555%인 경우 한 달에 최대 $1,000의 수익을 창출하는 거래의 경우 수익 공유는 거래 가격의 80.5555% 입니다.

  최종 수익 대역의 종료 단위를 지정하지 않으면 총수익이 해당 대역의 시작 단위를 초과한 후 모든 거래에 해당 대역의 수익 배분 비율이 적용됩니다. 예를 들어 마지막 범위의 시작 단위가 1,000(미국 달러로 가정)이고 해당 범위의 종료 단위를 지정하지 않으면 해당 범위의 수익 비율이 집계 기간 동안 수익이 1, 000달러를 초과하는 모든 거래에 적용됩니다.

요금제 속성의 전체 목록은 요금제 구성 속성을 참고하세요.

예를 들어 다음은 유연한 공유 모델이 포함된 수익 공유 계획을 만듭니다. 수익 대역 2개를 지정합니다. 첫 번째 구간은 최대 1,000달러를 초과하는 거래 수익을 대상으로 합니다. 두 번째 구간은 미화 1,000달러를 초과하는 거래 수익에 적용됩니다. 수익 배분율은 첫 번째 수익 구간에서 80.5555%, 두 번째 수익 구간에서 90.5% 입니다. 수익 공유는 거래의 순 가격을 기준으로 합니다. 집계 기준은 1개월입니다. 계약 기간은 2013년 9월 15일부터 유효하며, 결제 기한은 30일입니다. (수익 공유 관련 세부정보가 강조표시됨)

$ 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

응답은 다음과 같아야 합니다 (응답의 일부만 표시됨).

{
  "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"
}