조정 가능한 알림 계획 구성

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

소개

조정 가능한 알림 요금제에서 API 제공업체는 각 앱 개발자의 타겟 트랜잭션 수를 조정할 수 있습니다. 목표 수치의 백분율(예: 90%, 100%, 150%)에 도달한 시점을 기준으로 알림 전송 여부와 시기를 구성할 수 있습니다. 타겟 수에 도달한 후에는 추가 거래가 차단되지 않습니다.

UI를 사용하여 조정 가능한 알림 계획 구성

아래에 설명된 대로 조정 가능한 알림 계획을 구성합니다.

Edge

Edge UI를 사용하여 조정 가능한 알림 요금제를 구성하려면 요금제를 추가하거나 수정할 때 조정 가능한 알림 요금제 유형을 선택하고 조정 가능한 알림 섹션에서 다음 정보를 구성합니다.

필드 설명 기본값
계산 빈도 거래 수 (또는 맞춤 속성 관련 수량)가 계산되는 기간입니다. 개월 수를 선택합니다 (1~24개월). 1개월

API 제품에 맞춤 속성을 정의한 경우 맞춤 속성을 기반으로 거래 카운터를 정의하도록 맞춤 평가 매개변수를 구성할 수 있습니다.

예를 들어 다음을 수행해야 할 수 있습니다.

  • API 호출 메시지에 제공된 값을 기준으로 개발자에게 가변 금액을 청구합니다.
    예를 들어 API 요청에서 전송된 바이트 수에 따라 앱 개발자에게 요금을 부과할 수 있습니다.
  • 여러 API 호출을 단일 트랜잭션으로 번들로 묶습니다.
    이 경우 맞춤 평가 매개변수 사용을 선택하고 드롭다운 목록에서 맞춤 속성을 선택합니다.

자세한 내용은 맞춤 속성으로 요금제 구성을 참고하세요.

Classic Edge (Private Cloud)

기존 Edge UI를 사용하여 조정 가능한 알림 계획을 구성하려면 다음 단계를 따르세요.

  1. 요금제 창의 요금제 세부정보 탭에 있는 요금제 유형 필드에서 조정 가능한 알림을 선택합니다.

    요금제 창에 액세스하는 방법에 대한 자세한 내용은 UI를 사용하여 요금제 만들기를 참고하세요.

  2. 갱신 기간 입력란을 개발자가 해당 날짜 이전에 계약을 해지하지 않는 한 요금제가 자동으로 갱신되는 기간 (월)으로 설정합니다. 이 값을 0으로 설정하면 개발자가 계획을 종료하기로 선택할 때까지 계획이 계속 적용됩니다.
  3. 일반 요금제에서 세부정보를 클릭합니다.
  4. 집계 기준을 거래량이 집계되는 기간으로 설정합니다. 1~24개월 사이의 숫자를 선택합니다. 이 값의 기본값은 1개월입니다.
  5. 적용 및 닫기를 클릭합니다.
  6. 초안 저장을 클릭합니다.
  7. 계획이 최종적으로 확정된 경우에만 게시하세요. 게시 날짜 설정 및 요금제 게시에 관한 자세한 내용은 요금제 게시를 참고하세요.

    요금제를 게시한 후에는 종료일만 수정할 수 있습니다. 요금제를 게시한 후에는 삭제할 수 없지만 게시된 요금제 만료에 설명된 대로 요금제를 만료하고 향후 요금제로 대체할 수 있습니다.

API를 사용하여 조정 가능한 알림 계획 구성

/organizations/{org_name}/monetization-packages/{package_id}/rate-plans에 대한 POST 요청의 요청 본문에서 ratePlanDetails 속성의 조정 가능한 알림 계획 세부정보를 지정합니다.

조정 가능한 알림 요금제를 지정하려면 요청 본문의 ratePlanDetails에 다음 값을 지정합니다.

속성 값
type USAGE_TARGET로 설정합니다.
meteringType DEV_SPECIFIC로 설정합니다.
duration durationType와 함께 집계 기준의 기간으로 설정합니다. 조정 가능한 알림 요금제의 경우 1에서 24 사이의 정수 값으로 설정합니다.
durationType

durationType와 함께 집계 기준의 기간으로 설정합니다. 조정 가능한 알림 요금제의 경우 이 값을 MONTH로 설정합니다.

조정 가능한 알림 요금제 세부정보를 지정할 때 설정할 수 있는 구성 속성에 관한 자세한 내용은 요금제 세부정보 구성 설정을 참고하세요.

예를 들어 다음은 집계 기준을 1개월로 설정하여 조정 가능한 알림 계획을 정의합니다.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "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": "VOLUME",
           "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

API를 사용하여 각 앱 개발자의 대상 거래 수를 설정

조정 가능한 알림 비율 요금제를 수락한 각 앱 개발자의 경우 대상 거래 수를 설정해야 합니다. 목표 수치의 백분율(예: 90%, 100%, 150%)에 도달한 시점을 기준으로 알림 전송 여부와 시기를 구성할 수 있습니다. 타겟 수에 도달한 후에는 추가 거래가 차단되지 않습니다.

개발자가 요금제를 수락하면 앱 개발자의 거래 타겟 수를 설정할 수 있으며 나중에 값을 업데이트할 수 있습니다.

요금제를 수락할 때 거래 목표 수 설정

요금제를 수락할 때 타겟 거래 수를 설정하려면 /organizations/{org_name}/developers/{developer_id}/developer-rateplans 리소스에 대한 POST 요청의 요청 본문에서 quotaTarget 속성을 지정합니다. quotaTarget를 양의 정수 또는 0으로 설정하여 앱 개발자의 알림을 사용 중지합니다. 지정하지 않으면 quotaTarget의 기본값은 0입니다.

예를 들어 다음 요청에서는 앱 개발자가 조정 가능한 알림 요금제를 수락하면 트랜잭션 목표 수를 4, 000개로 설정합니다.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

수락된 요금제를 업데이트할 때 거래 목표 수 설정

거래 타겟 수를 설정하려면 수락된 요금제를 업데이트하고 /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} 리소스에 대한 PUT 요청의 요청 본문에서 quotaTarget 속성을 지정하면 됩니다. quotaTarget를 양의 정수 또는 0으로 설정하여 앱 개발자의 알림을 사용 중지합니다. 지정하지 않으면 quotaTarget의 기본값은 0입니다.

게시된 요금제에 동의하면 {developer_rateplan_id}가 응답에 반환됩니다.

예를 들면 다음과 같습니다.

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

또는 /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans에 GET 요청을 실행하여 개발자 요금제의 {developer-rateplan-id}를 가져올 수 있습니다. 여기서 {developer_id}는 개발자의 이메일 주소입니다. 자세한 내용은 개발자가 수락한 모든 요금제 보기를 참고하세요.

예를 들면 다음과 같습니다.

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}

다음 요청은 대상 거래 수를 4,000으로 업데이트합니다.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password