Apigee Edge 문서입니다.
Go to the
Apigee X documentation. info
소개
수익 공유 계획에서 API 제공업체는 각 트랜잭션에서 발생한 수익의 일정 비율을 개발자와 공유합니다 (트랜잭션의 총 가격 또는 순 가격 기준). 수익 공유 계획을 만들 때는 고정 또는 유연한 공유 모델과 가격 책정 기준 (예: 수익 공유가 트랜잭션의 총 가격 또는 순 가격을 기반으로 하는지 여부)을 표시해야 합니다. 트랜잭션 기록 정책을 만들 때 트랜잭션의 총 가격 또는 순 가격을 설정합니다.
고정 공유 모델에서는 각 트랜잭션에서 발생한 수익의 고정 비율을 개발자와 공유합니다 (트랜잭션의 총 가격 또는 순 가격 기준). 유연한 공유 모델에서는 수익의 변동 비율을 개발자와 공유합니다. 수익 공유는 일정 기간 동안 발생한 수익에 따라 달라집니다. 수익 공유 계산에 사용되는 비율은 트랜잭션에서 발생한 수익 금액에 따라 달라질 수 있습니다.
UI를 사용하여 수익 공유 계획 세부정보 지정
아래 설명된 대로 수익 공유 계획을 구성합니다.
Edge
Edge UI를 사용하여 수익 공유 계획을 구성하려면 요금제를 만들거나 수정할 때 수익 공유 또는 요금표 및 수익 공유 요금제 유형을 선택하고 수익 공유 섹션에서 다음 정보를 구성합니다.
| 필드 | 설명 |
| 계산 모델 | 다음 가격 책정 유형 중 하나를 선택합니다.
|
| 계산 빈도 | 트랜잭션 수 (또는 맞춤 속성 관련 수)가 계산되는 기간입니다. 월 수 (1~24개월)를 선택합니다. |
| 공유 모델 | 다음 수익 공유 모델 중 하나를 선택합니다.
|
| 고정 수익 공유 | 고정 공유 모델의 경우 수익 공유를 계산하는 데 사용되는 비율을 지정합니다. 소수점 이하 4자리까지의 십진수를 입력합니다. 예를 들어 80.5555를 입력하면 수익 공유는 80.5555%입니다. 즉, API 제공업체는 각 트랜잭션에 청구된 가격의 80.5555% 를 개발자에게 지급합니다. |
| 수익 공유 대역 | 유연한 공유 모델의 경우 하나 이상의 트랜잭션 수익 범위 (각 범위는 '수익 대역'임). 각 수익 대역에 수익 공유 비율을 할당할 수 있습니다. 트랜잭션은 집계 기준에 따라 집계되어 총 수익과 트랜잭션의 수익 대역을 계산합니다. 각 트랜잭션에 적용되는 수익 공유 비율은 수익 대역에 따라 달라집니다. 첫 번째 대역의 상한을 지정합니다 (예: 최대 1000, 하한은 0보다 큰 값으로 미리 설정됨). +새로 만들기 를 클릭하여 대역을 추가합니다. 총 수익이 이 수준을 초과한 후의 모든 트랜잭션을 나타내려면 최종 대역의 상한을 비워 둡니다. 예를 들어 수익 대역 섹션에서 두 개의 수익 대역(>0~1000, 1000 이상)을 지정하는 경우 >0~1000 수익 대역에 80.5555를 입력하고 1000 이상 수익 대역에 90.5를 입력할 수 있습니다. 또한 통화는 미국 달러라고 가정합니다. 그러면 최대 1,000달러의 수익을 창출하는 트랜잭션의 경우 수익 공유는 트랜잭션 가격의 80.5555% 이고 1,000달러 이상의 수익을 창출하는 트랜잭션의 경우 수익 공유는 트랜잭션 가격의 90.5% 입니다. |
기존 Edge (Private Cloud)
기존 Edge UI를 사용하여 수익 공유 계획을 구성하려면 다음 단계를 따르세요.
- 요금제를 만드는 단계를 따릅니다.
- 요금제 유형 드롭다운에서 수익 공유 를 선택하여 수익 모델을 구성합니다.
- 선택한 API 패키지에 여러 API 제품이 포함되어 있는 경우 다음 옵션 중 하나를 선택합니다.
참고: API 패키지에 단일 API 제품이 포함되어 있는 경우 이 단계를 건너뛸 수 있습니다.
- 각 API 제품의 요금제 세부정보를 개별적으로 구성하려면 제품별 계획 을 선택합니다.
- 모든 API 제품의 요금제 세부정보를 구성하려면 모든 제품의 일반 계획 을 선택합니다.
- 일반 요금제 또는 각 API 제품별 요금제에 대해 수익 공유 를 클릭합니다.
참고: API 제품별 계획을 구성할 때는 각 API 제품의 수익 공유 계획 을 개별적으로 구성해야 합니다.

수익 공유 창이 열립니다.

- 다음 공유 모델 중 하나를 선택합니다.
- 고정: 이 모델에서 API 제공업체는 각 트랜잭션에서 발생한 수익의 고정 비율을 개발자와 공유합니다 (트랜잭션의 총 가격 또는 순 가격 기준).
- 유연: 이 모델에서 API 제공업체는 수익의 변동 비율을 개발자와 공유합니다. 수익 공유는 일정 기간 동안 발생한 수익에 따라 달라집니다. 수익 공유 계산에 사용되는 비율은 트랜잭션에서 발생한 수익 금액에 따라 달라질 수 있습니다.
고정 공유 모델의 경우:
고정 공유 모델을 선택하는 경우 일반 수익 공유 창의 가격 책정 섹션에 다음 정보를 입력합니다.
필드 설명 운영자 (또는 조직) 조직 이름입니다. 이 필드는 조직 프로필의 운영자 (또는 조직) 필드 값을 사용하여 미리 설정됩니다.
국가 조직의 운영 국가입니다. 이 필드는 조직 프로필의 국가 필드 값을 사용하여 미리 설정됩니다.
통화 회사에서 사용하는 '기본' 또는 회계 통화입니다. 이 필드는 조직 프로필의 통화 필드 값을 사용하여 미리 설정됩니다.
가격 책정 유형 수익 공유의 기준입니다. 총 또는 순을 선택합니다. 총을 선택하면 수익 공유는 트랜잭션의 총 가격의 비율을 기반으로 합니다. 순을 선택하면 수익 공유는 트랜잭션의 순 가격의 비율을 기반으로 합니다. 참고: 트랜잭션 기록 정책을 만들 때 트랜잭션의 총 가격 또는 순 가격을 설정합니다.
고정 공유 비율(%) 수익 공유를 계산하는 데 사용되는 비율입니다. 소수점 이하 4자리까지의 십진수를 입력합니다. 예를 들어 80.5555를 입력하면 수익 공유는 80.5555%입니다. 즉, API 제공업체는 각 트랜잭션에 청구된 가격의 80.5555% 를 개발자에게 지급합니다.
유연한 공유 모델의 경우:
유연한 공유 모델을 선택하면 일반 수익 공유 창에 추가 필드가 표시됩니다. 이러한 필드를 사용하여 집계의 기준을 지정하고 '수익 대역', 즉 서로 다른 수익 공유 비율을 적용할 수 있는 트랜잭션 생성 수익 범위를 지정합니다.

일반 수익 공유 창에 다음 정보를 입력합니다.
필드 설명 집계 기준 수익이 집계되는 기간입니다. 집계된 수익은 각 트랜잭션의 수익 대역 (및 적용 가능한 수익 공유 비율)을 계산하는 데 사용됩니다. 월 수 (1~12개월)를 선택합니다.
수익 대역 하나 이상의 트랜잭션 수익 범위 (각 범위는 '수익 대역'임). 각 수익 대역에 수익 공유 비율을 할당할 수 있습니다 (이 비율은 가격 책정 섹션의 수익 대역 필드에서 설정). 트랜잭션은 집계 기준에 따라 집계되어 총 수익과 트랜잭션의 수익 대역을 계산합니다. 각 트랜잭션에 적용되는 수익 공유 비율은 수익 대역에 따라 달라집니다.
첫 번째 대역의 상한을 지정합니다 (예: 최대 1000, 하한은 0보다 큰 값으로 미리 설정됨) ). +를 클릭하여 두 번째 대역(예: 1000보다 크고 2000 이하)을 추가합니다. +를 클릭하여 대역을 더 추가합니다. 총 수익이 이 수준을 초과한 후의 모든 트랜잭션을 나타내려면 최종 대역의 상한을 비워 둡니다.

가격 책정 운영자 (또는 조직) 조직 이름입니다. 이 필드는 조직 프로필의 운영자 (또는 조직) 필드 값을 사용하여 미리 설정됩니다.
국가 조직의 운영 국가입니다. 이 필드는 조직 프로필의 국가 필드 값을 사용하여 미리 설정됩니다.
통화 조직에서 사용하는 '기본' 또는 회계 통화입니다. 이 필드는 조직 프로필의 통화 필드 값을 사용하여 미리 설정됩니다.
가격 책정 유형 수익 공유의 기준입니다. 총 또는 순을 선택합니다. 총을 선택하면 수익 공유는 트랜잭션의 총 가격의 비율을 기반으로 합니다. 순을 선택하면 수익 공유는 트랜잭션의 순 가격의 비율을 기반으로 합니다. 참고: 트랜잭션 기록 정책을 만들 때 트랜잭션의 총 가격 또는 순 가격을 설정합니다.
수익 대역의 공유 비율(%) 각 수익 대역의 트랜잭션에 대한 수익 공유를 계산하는 데 사용되는 비율입니다. 각 대역의 비율을 지정합니다. 소수점 이하 4자리까지의 십진수를 입력합니다. 예를 들어 수익 대역 섹션에서 두 개의 수익 대역 (>0~1000, 1000 이상)을 지정하는 경우 >0~1000 수익 대역에 80.5555를 입력하고 1000 이상 수익 대역에 90.5를 입력할 수 있습니다. 또한 통화는 미국 달러라고 가정합니다. 그러면 최대 1,000달러 의 수익을 창출하는 트랜잭션의 경우 수익 공유는 트랜잭션 가격의 80.5555% 이고 1,000달러 이상의 수익을 창출하는 트랜잭션의 경우 수익 공유는 트랜잭션 가격의 90.5% 입니다.

- 적용 및 닫기 를 클릭하여 수익 공유 세부정보를 저장하고 표준 요금제 창으로 돌아갑니다.
- API 제품별 요금제의 경우 필요에 따라 추가 API 제품의 요금제 세부정보를 구성합니다.
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으로 지정하고 종료 단위를 1000으로 지정하면 수익 대역은 지정된 통화로 0보다 크고 최대 1000까지의 트랜잭션 수익을 포함합니다. 통화가 미국 달러이고 집계 기준이 1개월이며 수익 대역의 비율이 80.5555%인 경우 한 달에 최대 1,000달러의 수익을 창출하는 트랜잭션의 경우 수익 공유는 트랜잭션 가격의 80.5555% 입니다.
최종 수익 대역의 종료 단위를 지정하지 않으면 해당 대역의 공유 비율이 총 수익이 해당 대역의 시작 단위를 초과한 후의 모든 트랜잭션에 적용됩니다. 예를 들어 마지막 대역의 시작 단위가 1000 (미국 달러라고 가정)이고 해당 대역의 종료 단위를 지정하지 않으면 해당 대역의 수익 비율이 집계 기간 동안 1,000달러를 초과하는 모든 트랜잭션에 적용됩니다.
요금제 속성의 전체 목록은 요금제의 구성 속성을 참고하세요.
예를 들어 다음은 유연한 공유 모델로 수익 공유 계획을 만듭니다. 두 개의 수익 대역을 지정합니다. 첫 번째 대역은 0보다 크고 최대 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" }