조정 가능한 알림 계획 구성

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

소개

조정 가능한 알림 계획에서 API 제공자는 거래 내역을 확인할 수 있습니다 알림 전송 여부와 시기를 목표 수치의 특정 비율(예: 90%, 100%, 150%)에 도달했을 때 실행됩니다. 추가 목표 수치에 도달한 후에도 거래가 차단되지 않습니다.

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

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

에지Classic Edge (Private Cloud)

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

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

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

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

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

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

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

  1. 요금제 유형에서 조정 가능한 알림을 선택합니다. 요금제를 클릭합니다.

    UI를 사용하여 요금제 만들기를 참조하세요. 를 참조하세요.

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

    요금제를 게시한 후에는 종료일만 수정할 수 있습니다. 요금은 삭제할 수 없습니다. 게시된 후 요금제가 취소되지만, 요금제를 만료하고 향후 요금으로 대체할 수 있습니다. 게시된 요금 만료 요금제를 참고하세요.

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

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

조정 가능한 알림 계획을 지정하려면 요청 본문의 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%). 목표 횟수에 도달한 후에는 추가 거래가 차단되지 않습니다.

개발자가 수락하면 앱 개발자의 목표 거래 수를 설정할 수 있습니다. 나중에 값을 업데이트할 수 있습니다.

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

요금제를 수락할 때 목표 거래 수를 설정하려면 quotaTarget 속성을 /organizations/{org_name}/developers/{developer_id}/developer-rateplans 리소스. quotaTarget를 양의 정수 또는 0으로 설정하여 앱 알림을 사용 중지합니다. 있습니다. 지정되지 않은 경우 quotaTarget의 기본값은 0입니다.

예를 들어 다음 요청은 앱이 개발자가 조정 가능한 알림 계획을 수락합니다.

$ 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

허용되는 요금제를 업데이트할 때 목표 트랜잭션 수 설정

목표 거래 수를 설정하려면 허용되는 요금제를 업데이트하고 quotaTarget 속성을 /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} 리소스도 제공합니다 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
}

또는 개발자 요율의 {developer-rateplan-id}를 가져올 수 있습니다. GET 요청을 실행하여 /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, 여기서 {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 \
'{ 
   &quot;id&quot; : 'b1c600b8-f871-496d-8173-12b9950d6ab1',
   &quot;developer&quot;:{
     "id":"dev@mycompany.com"
   }님, 안녕하세요.
   &quot;ratePlan&quot;:{
     &quot;id&quot;:&quot;p1_adjustable-notification-plan&quot;
   }님, 안녕하세요.
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false

}' \
&quot;https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1&quot;
-u email:password