맞춤 속성으로 요금제 구성

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

소개

경우에 따라 거래 카운터가 변수 또는 맞춤 값을 기반으로 해야 할 수도 있습니다. 예를 들어 다음을 수행해야 할 수 있습니다.

  • API의 메시지에 제공된 값을 기반으로 개발자에게 변동된 금액을 청구합니다. 있습니다. 예를 들어, 바이트 수에 따라 앱 개발자에게 요금을 부과할 수 있습니다. API 요청에서 전송됩니다.
  • 여러 API 호출을 단일 트랜잭션으로 묶습니다.

맞춤 속성과 함께 요금제를 사용하면 API 메시지에서 값을 식별할 수 있습니다. 카운터 역할을 하며 거래 횟수와 청구 금액을 계산하는 데 사용됩니다.

맞춤 속성이 있는 다음 요금제가 지원됩니다.

  • 맞춤 속성이 있는 요율표
  • 맞춤 속성이 있는 조정 가능한 알림

요금제당 최대 10개의 맞춤 속성을 설정할 수 있습니다.

맞춤 속성 계산 이해

요금제 거래 수 및 청구 금액에 맞춤 속성 값이 반영되는 방식 다음 표에 요약된 것처럼 청구 모델에 따라 다릅니다.

충전 모델 맞춤 속성 계산
고정 요금 및 볼륨 밴드

custom attribute number * rate = charge to developer

고정 요금의 경우 맞춤 속성 숫자가 해당 값이 적용되는 거래 수가 됩니다. 비율에 따라 곱해집니다. 볼륨 밴드의 경우 대역 내 트랜잭션 수입니다. 맞춤 속성 번호만큼 증가하여 개발자에게 비용이 청구됩니다. 거래 횟수 예를 들어 메시지의 맞춤 속성 값이 10인 경우 개발자에게 거래 10건이 청구되고 10건은 현재 대역 수입니다. 개발자에게 현재 남은 거래가 6개뿐인 경우 6에 해당 대역의 비율을 곱합니다. 나머지 4명은 다음 밴드로 나뉩니다. 해당 대역의 속도를 곱합니다.

볼륨 밴드 요금제에서 마지막 볼륨 대역에 한도가 있는 경우('무제한'이 아님) 거래가 해당 한도를 초과하면 두 가지 상황이 발생합니다.

  • 개발자가 복구 작업 수행 무료로 이용할 수 있습니다
  • 개발자 앱이 계획될 때까지 API를 추가로 호출하지 못하도록 차단됩니다. 생리 기간이 재설정됩니다.
    자세한 내용은 요금이 청구되고 번들 요금제가 재설정되나요?를 참고하세요. 재설정합니다.
번들

번들 요금은 거래가 아닌 그룹에서 청구하므로 다음과 같이 계산됩니다.

custom attribute number = amount added to bundle count

예를 들어 메시지의 맞춤 속성 번호가 10이면 10이 번들에 사용된 트랜잭션 수입니다 개발자가 남은 트랜잭션이 있으면 이 번들이 채워지고 번들 수는 4씩 증가합니다. 다음 번들의 요율(있는 경우)은 있습니다.

마지막 번들에 한도('무제한'이 아님)가 있고 거래가 한도를 초과하는 경우 한도를 초과하면 두 가지 결과가 발생합니다.

  • 개발자가 복구 작업 수행 무료로 이용할 수 있습니다
  • 개발자 앱이 계획될 때까지 API를 추가로 호출하지 못하도록 차단됩니다. 생리 기간이 재설정됩니다.
    자세한 내용은 요금이 청구되고 번들 요금제가 재설정되나요?를 참고하세요. 재설정합니다.
조정 가능한 알림

조정 가능한 알림의 경우 다음과 같이 계산됩니다.

custom attribute number = amount added to transaction count

예를 들어 메시지의 맞춤 속성 번호가 10이면 10이 총 거래 건수입니다.

요금제에서 맞춤 속성 값

API 제품 번들의 거래 기록 정책은 수익 창출에 메시지가 표시됩니다. 맞춤 속성은 맞춤 속성 섹션에 나와 있습니다.

그런 다음 API를 만든 후에 요금제에서 맞춤 속성을 선택할 수 있습니다. 거래 기록 정책이 포함된 제품 번들을 맞춤 속성이 정의되어 있습니다.

대략적인 흐름은 다음과 같습니다.

  1. API 제품을 추가할 때 맞춤 속성을 정의합니다.
  2. 제품이 포함된 API 제품 번들을 만듭니다.
    API 제품 번들의 거래 기록 정책에 요금제 정의에 사용됩니다.
  3. 요율표 유형 또는 조정 가능한 알림의 요금제를 생성합니다. 를 설정하고 맞춤 평점 매개변수를 지정하세요.

다음 그림은 거래 기록 정책 및 요율표 요금제 구성 이 맞춤 속성 요금제 관계가 있는 조정 가능한 알림은 비슷하지만 볼륨 밴드 값을 적용할 수 없습니다.

커스텀 메시지의 속성 값

거래 기록 정책은 여러 위치에서 맞춤 속성 값을 찾을 수 있습니다. 응답 헤더, 응답 본문 또는 응답의 사전 정의된 흐름 변수 등입니다. ( response.) 다음은 응답 헤더를 숫자 값을 메시지에 추가합니다. 두 경우 모두 다음에서 메시지 할당 정책을 사용합니다. 사용할 수 있습니다.

응답 헤더에 요청 페이로드 크기 추가

각 메시지 요청에는 client.received.content.length 변수가 있습니다. 에는 요청 페이로드의 바이트 수가 포함됩니다. 프록시 엔드포인트 응답을 대상으로 하는 경우 messageSize라는 응답 헤더를 생성할 수 있습니다. 에는 길이 값이 포함됩니다.

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

헤더에 앱 맞춤 속성 값 추가

거의 같은 방식으로 앱에서 맞춤 속성 값을 사용하여 헤더를 생성할 수 있습니다. 예를 들어 각 개발자에 apprating라는 맞춤 속성을 포함하는 경우 앱에 적용할 수 있습니다.

수익 창출에 필요한 API 키 인증 정책을 사용할 때 이 값은 verifyapikey.{policy_name}.apprating라는 변수에 저장됩니다. 할당 사용 프록시 엔드포인트 응답에 연결된 메시지 정책을 사용 중인 경우 앱의 apprating 값이 포함된 apprating:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

요금제 설정

위에서 설명한 맞춤 속성 설정을 제외하고 요금제는 동일한 방식으로 설정됩니다. (맞춤 속성이 없는 요금제의 경우)와 마찬가지로 다음 요구사항을 충족해야 합니다

<ph type="x-smartling-placeholder">

UI를 사용하여 맞춤 속성으로 요율표 계획 구성

다음 섹션에 설명된 대로 Edge UI 또는 기본 Edge UI를 사용하여 맞춤 속성이 있는 요율표 요금제를 구성합니다.

에지

Edge UI를 사용하여 맞춤 속성으로 요율표 요금제를 구성하려면 다음 단계를 따르세요.

  1. API 제품을 추가할 때 맞춤 속성을 정의합니다.
  2. 제품이 포함된 API 제품 번들을 만듭니다. API 제품 번들 만들기를 참고하세요.
    API 제품 번들의 거래 기록 정책에 요금제 정의에 사용됩니다. 자세한 내용은 이 주제의 소개와 트랜잭션 기록 정책을 만듭니다.
  3. API 제품 번들의 요금제를 생성합니다. 맞춤 평가 매개변수를 지정합니다.

자세한 내용은 UI를 사용하여 요율표 요금제 세부정보 구성을 참조하세요.

Classic Edge (Private Cloud)

기본 Edge UI를 사용하여 커스텀 속성 요금제로 요율표를 만들려면 다음 단계를 따르세요.

  1. API 제품의 거래 기록 정책에 요금제 정의에 사용됩니다. 자세한 내용은 본 주제 소개와 거래 만들기를 참조하세요. 녹화 정책을 준수해야 합니다. API 패키지에 포함하려는 각 API 제품에 대해 이 작업을 수행합니다.
  2. API 제품 및 트랜잭션 기록 정책이 제품을 원하는 경우 제품이 포함된 API 패키지를 만듭니다. API 패키지 만들기를 참조하세요.
  3. API 패키지의 요금제를 만들고 요율표의 요금제 유형을 선택합니다. 맞춤 속성 사용을 참조하세요.

  4. 요율표 링크를 클릭합니다. 그러면 요율표 창이 열립니다.

  5. 맞춤 속성 드롭다운 메뉴에서 맞춤 속성을 선택합니다. 메뉴에는 속성을 기록합니다. 개발자에게 청구됨 각 거래에서 선택된 맞춤 속성의 값에 따라 달라집니다.
    (속성 값 * 요율 = 개발자에게 청구)
  6. 원하는 경우 요율표 요금제 지정에 설명된 대로 부분 유료 요금제를 설정합니다. 자세히 알아보세요.
  7. 요율표 요금제 지정에 설명된 대로 청구 모델 설정 자세히 알아보세요. 하지만 맞춤 속성 요금제 유형이 있는 요율표의 경우 선택한 맞춤 속성에 따라 요금이 청구됩니다. 예를 들어 플랫을 선택한 경우 청구 모델로서 개발자에게 맞춤 요율을 기준으로 고정 요금을 부과합니다. 속성 (예: 각 트랜잭션에서 전송된 바이트 수) 발생할 수 있습니다. 자세한 내용은 계산을 참고하세요.
  8. 저장을 클릭합니다. 초안.
    확정된 내용이라고 확신할 때만 계획을 게시하세요. 게시하기 자세한 내용은 요금제를 참조하시기 바랍니다. 있습니다.

자세한 내용은 을(를) 참조하세요. UI를 사용하여 요율표 요금제 세부정보 지정하기

UI를 사용하여 커스텀 속성으로 조정 가능한 알림 계획 구성

아래 설명에 따라 커스텀 속성으로 조정 가능한 알림 계획을 구성합니다.

에지

Edge UI를 사용하여 맞춤 속성으로 요율표 요금제를 구성하려면 다음 단계를 따르세요.

  1. API 제품을 추가할 때 맞춤 속성을 정의합니다.
  2. 제품이 포함된 API 제품 번들을 만듭니다. API 제품 번들 만들기를 참고하세요.
    API 제품 번들의 거래 기록 정책에 요금제 정의에 사용됩니다. 자세한 내용은 이 주제의 소개와 트랜잭션 기록 정책을 만듭니다.
  3. API 제품 번들의 요금제를 생성합니다. 맞춤 평가 매개변수를 지정합니다.

자세한 내용은 UI를 사용하여 조정 가능한 알림 계획 구성을 참고하세요.

Classic Edge (Private Cloud)

기본 Edge UI를 사용하여 맞춤 속성으로 요율표 요금제를 구성하려면 다음 단계를 따르세요.

  1. API 제품의 거래 기록 정책에 요금제 정의에 사용됩니다. 자세한 내용은 본 주제 소개와 거래 만들기를 참조하세요. 녹화 정책을 준수해야 합니다. API 패키지에 포함하려는 각 API 제품에 대해 이 작업을 수행합니다.
  2. API 제품 및 트랜잭션 기록 정책이 제품을 원하는 경우 제품이 포함된 API 패키지를 만듭니다. API 패키지 만들기를 참조하세요.
  3. API 패키지의 요금제를 만들고 요금제 유형으로 조정 가능 요금제를 선택합니다. 맞춤 속성이 있는 알림.

  4. 세부정보 링크를 클릭합니다. 그러면 조정 가능한 알림이 열립니다. 창

  5. 맞춤 속성 드롭다운 메뉴에서 맞춤 속성을 선택합니다. 메뉴 거래 기록 정책에 제품에 대해 생성된 맞춤 속성이 나열됩니다. 이 개발자의 총 거래 수는 선택한 맞춤 속성을 설정해야 합니다.
  6. 집계 기준을 데이터가 집계되는 기간으로 설정합니다. 거래가 집계됩니다 1~24개월 사이의 숫자를 선택하세요. 이 값의 기본값은 1입니다. 월
  7. 적용 및 닫기를 클릭합니다.
  8. 저장을 클릭합니다. 초안.
    확정된 내용이라고 확신할 때만 계획을 게시하세요. 게시하기 자세한 내용은 요금제를 참조하시기 바랍니다. 있습니다.

자세한 내용은 을(를) 참조하세요. UI를 사용하여 조정 가능한 알림 계획 세부정보를 지정합니다.

API를 사용하여 맞춤 속성이 있는 요금제의 세부정보 지정

다음 기본 요건 단계를 수행합니다.

  1. API 제품의 거래 기록 정책에 요금제 정의에 사용됩니다. 자세한 내용은 본 주제 소개와 거래 만들기를 참조하세요. 녹화 정책을 준수해야 합니다. API 패키지에 포함하려는 각 API 제품에 대해 이 작업을 수행합니다.
  2. API 제품 및 트랜잭션 기록 정책이 제품을 원하는 경우 제품이 포함된 API 패키지를 만듭니다. API 패키지 만들기를 참조하세요.

다음으로 API를 사용하여 요금제를 만듭니다.

요금제를 만들 때 맞춤 속성을 사용하여 요금제의 세부정보를 지정합니다. 나 요청 본문 내의 ratePlanDetails 속성에 세부정보를 지정합니다. /organizations/{org_name}/monetization-packages/{package_id}/rate-plans 호출 포함 세부정보에 대해 알아보려면 맞춤 목록의 이름을 식별하는 평점 매개변수 값을 속성의 값을 제공합니다. 맞춤 속성을 집계하는 평점 매개변수 값을 지정할 수도 있습니다. 입찰합니다.

요금제 보기 세부정보 구성 설정을 참조하세요.

예를 들어 다음은 이름이 messageSize인 속성 (굵게 표시된 항목 참고)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "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

다음은 이름이 messageSize인 맞춤 속성입니다 (굵게 표시된 항목 참고).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "messageSize",
           "ratingParameterUnit": "MB",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password