조정 가능한 알림 요금제 구성

Apigee Edge 문서입니다.
Go to the Apigee X 문서로 이동합니다. info

소개

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

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

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

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

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

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

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

예를 들어 다음은 집계 기준 이 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를 사용하여 각 앱 개발자의 목표 트랜잭션 수 설정

개발자가 요금제를 수락할 때 앱 개발자의 목표 트랜잭션 수를 설정할 수 있으며 나중에 값을 업데이트할 수 있습니다.

요금제를 수락할 때 목표 트랜잭션 수 설정

요금제를 수락할 때 목표 트랜잭션 수를 설정하려면 quotaTarget 속성을 /organizations/{org_name}/developers/{developer_id}/developer-rateplans 리소스에 대한 POST 요청의 요청 본문에 지정합니다. 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

수락된 요금제를 업데이트할 때 목표 트랜잭션 수 설정

목표 트랜잭션 수를 설정하려면 수락된 요금제를 업데이트하고 quotaTarget 속성을 /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} 리소스에 대한 PUT 요청의 요청 본문에 지정합니다. 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}를 {developer_id}가 개발자의 이메일 주소인 /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans에 GET 요청을 실행하여 가져올 수 있습니다. 자세한 내용은 개발자가 수락한 모든 요금제 보기 를 참조하세요.

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

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